[{"id":25466,"web_url":"https://patchwork.libcamera.org/comment/25466/","msgid":"<166617882484.2560709.18190382231598659150@Monstersaurus>","date":"2022-10-19T11:27:04","subject":"Re: [libcamera-devel] [PATCH v1 1/4] ipa: Drop period at end of\n\t\\brief or \\param","submitter":{"id":4,"url":"https://patchwork.libcamera.org/api/people/4/","name":"Kieran Bingham","email":"kieran.bingham@ideasonboard.com"},"content":"Quoting Laurent Pinchart via libcamera-devel (2022-10-19 12:04:31)\n> A few periods crept in at the end of Doxygen \\brief or \\param statements\n> in the src/ipa/ directory. Remove them all in one go.\n> \n\nAll of the patches are this easy right ...\n\nReviewed-by: Kieran Bingham \n\n> Signed-off-by: Laurent Pinchart \n> ---\n> src/ipa/ipu3/algorithms/af.cpp | 18 +++++++++---------\n> src/ipa/ipu3/ipa_context.cpp | 6 +++---\n> src/ipa/libipa/algorithm.cpp | 2 +-\n> src/ipa/libipa/histogram.cpp | 2 +-\n> 4 files changed, 14 insertions(+), 14 deletions(-)\n> \n> diff --git a/src/ipa/ipu3/algorithms/af.cpp b/src/ipa/ipu3/algorithms/af.cpp\n> index b00a34f9e090..75632aa39d21 100644\n> --- a/src/ipa/ipu3/algorithms/af.cpp\n> +++ b/src/ipa/ipu3/algorithms/af.cpp\n> @@ -267,9 +267,9 @@ void Af::afReset(IPAContext &context)\n> }\n> \n> /**\n> - * \\brief AF variance comparison.\n> + * \\brief AF variance comparison\n> * \\param[in] context The IPA context\n> - * \\param[in] min_step The VCM movement step.\n> + * \\param[in] min_step The VCM movement step\n> *\n> * We always pick the largest variance to replace the previous one. The image\n> * with a larger variance also indicates it is a clearer image than previous\n> @@ -322,7 +322,7 @@ bool Af::afScan(IPAContext &context, int min_step)\n> }\n> \n> /**\n> - * \\brief Determine the frame to be ignored.\n> + * \\brief Determine the frame to be ignored\n> * \\return Return True if the frame should be ignored, false otherwise\n> */\n> bool Af::afNeedIgnoreFrame()\n> @@ -335,7 +335,7 @@ bool Af::afNeedIgnoreFrame()\n> }\n> \n> /**\n> - * \\brief Reset frame ignore counter.\n> + * \\brief Reset frame ignore counter\n> */\n> void Af::afIgnoreFrameReset()\n> {\n> @@ -377,8 +377,8 @@ double Af::afEstimateVariance(Span y_items, bool isY1)\n> }\n> \n> /**\n> - * \\brief Determine out-of-focus situation.\n> - * \\param[in] context The IPA context.\n> + * \\brief Determine out-of-focus situation\n> + * \\param[in] context The IPA context\n> *\n> * Out-of-focus means that the variance change rate for a focused and a new\n> * variance is greater than a threshold.\n> @@ -404,11 +404,11 @@ bool Af::afIsOutOfFocus(IPAContext &context)\n> }\n> \n> /**\n> - * \\brief Determine the max contrast image and lens position.\n> - * \\param[in] context The IPA context.\n> + * \\brief Determine the max contrast image and lens position\n> + * \\param[in] context The IPA context\n> * \\param[in] frame The frame context sequence number\n> * \\param[in] frameContext The current frame context\n> - * \\param[in] stats The statistics buffer of IPU3.\n> + * \\param[in] stats The statistics buffer of IPU3\n> *\n> * Ideally, a clear image also has a relatively higher contrast. So, every\n> * image for each focus step should be tested to find an optimal focus step.\n> diff --git a/src/ipa/ipu3/ipa_context.cpp b/src/ipa/ipu3/ipa_context.cpp\n> index f276227c1ecc..68f017b04751 100644\n> --- a/src/ipa/ipu3/ipa_context.cpp\n> +++ b/src/ipa/ipu3/ipa_context.cpp\n> @@ -68,7 +68,7 @@ namespace libcamera::ipa::ipu3 {\n> * \\brief AF grid configuration of the IPA\n> *\n> * \\var IPASessionConfiguration::af.afGrid\n> - * \\brief AF scene grid configuration.\n> + * \\brief AF scene grid configuration\n> */\n> \n> /**\n> @@ -79,10 +79,10 @@ namespace libcamera::ipa::ipu3 {\n> * \\brief Current position of the lens\n> *\n> * \\var IPAActiveState::af.maxVariance\n> - * \\brief The maximum variance of the current image.\n> + * \\brief The maximum variance of the current image\n> *\n> * \\var IPAActiveState::af.stable\n> - * \\brief It is set to true, if the best focus is found.\n> + * \\brief It is set to true, if the best focus is found\n> */\n> \n> /**\n> diff --git a/src/ipa/libipa/algorithm.cpp b/src/ipa/libipa/algorithm.cpp\n> index c152b885aee1..55abddab2b0a 100644\n> --- a/src/ipa/libipa/algorithm.cpp\n> +++ b/src/ipa/libipa/algorithm.cpp\n> @@ -72,7 +72,7 @@ namespace ipa {\n> * \\param[in] context The shared IPA context\n> * \\param[in] frame The frame context sequence number\n> * \\param[in] frameContext The FrameContext for this frame\n> - * \\param[out] params The ISP specific parameters.\n> + * \\param[out] params The ISP specific parameters\n> *\n> * This function is called for every frame when the camera is running before it\n> * is processed by the ISP to prepare the ISP processing parameters for that\n> diff --git a/src/ipa/libipa/histogram.cpp b/src/ipa/libipa/histogram.cpp\n> index 69b461779a1f..6b5cde8e0ab3 100644\n> --- a/src/ipa/libipa/histogram.cpp\n> +++ b/src/ipa/libipa/histogram.cpp\n> @@ -53,7 +53,7 @@ Histogram::Histogram(Span data)\n> */\n> \n> /**\n> - * \\brief Cumulative frequency up to a (fractional) point in a bin.\n> + * \\brief Cumulative frequency up to a (fractional) point in a bin\n> * \\param[in] bin The bin up to which to cumulate\n> *\n> * With F(p) the cumulative frequency of the histogram, the value is 0 at\n> -- \n> Regards,\n> \n> Laurent Pinchart\n>","headers":{"Return-Path":"","X-Original-To":"parsemail@patchwork.libcamera.org","Delivered-To":"parsemail@patchwork.libcamera.org","Received":["from lancelot.ideasonboard.com (lancelot.ideasonboard.com\n\t[92.243.16.209])\n\tby patchwork.libcamera.org (Postfix) with ESMTPS id 8A4BEC0DA4\n\tfor ;\n\tWed, 19 Oct 2022 11:27:10 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id B3A6362E51;\n\tWed, 19 Oct 2022 13:27:09 +0200 (CEST)","from perceval.ideasonboard.com (perceval.ideasonboard.com\n\t[213.167.242.64])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id EDAD262DFA\n\tfor ;\n\tWed, 19 Oct 2022 13:27:07 +0200 (CEST)","from pendragon.ideasonboard.com\n\t(cpc89244-aztw30-2-0-cust3082.18-1.cable.virginm.net [86.31.172.11])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id 60F345A4;\n\tWed, 19 Oct 2022 13:27:07 +0200 (CEST)"],"DKIM-Signature":["v=1; a=rsa-sha256; c=relaxed/simple; d=libcamera.org;\n\ts=mail; t=1666178829;\n\tbh=kQmb7Wukp7cZJ6yaplvtQteF7ccKbcVsiolaHJqNN5w=;\n\th=In-Reply-To:References:To:Date:Subject:List-Id:List-Unsubscribe:\n\tList-Archive:List-Post:List-Help:List-Subscribe:From:Reply-To:\n\tFrom;\n\tb=gak5jgFRvEJErLEHOlZBGHyWFqcE+lWgIPAbhuO6DMrb1uJtjiVp3PiVV/RH2GmNx\n\tekRssMdUBNTgr1nMlNzQLrx3Zq+RAXe6YrL4xuZHul1aWa0NjecUkj1pJrbc4MnqLW\n\t7IzWIVOV/HcXj4DWkwDzu1/AU8VQ/3spkGtczU6I6DTGTkTl/zJEdb96IHWsU1Dkre\n\txr/FOShRav9QJDFJjpo+8dAkxfNqxdxJyNy2heaW8ZC32hfcYyG+zCA27A//GW+jnG\n\tSBzzkxMov4R41E67iDBKACHNdGoM/7R4hYEBGkLGSuckCxsuuwjgYet8xfgrI3jsI6\n\tSbWeof/VtQnrg==","v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1666178827;\n\tbh=kQmb7Wukp7cZJ6yaplvtQteF7ccKbcVsiolaHJqNN5w=;\n\th=In-Reply-To:References:Subject:From:To:Date:From;\n\tb=GHcLgs0Mk86e41caDxV+PBa9LhpLtsUYJsAd9vSe3oUgYw72DUAzEWx1jVwU7XIg3\n\t1HlS8nCmZ8xDuDyGTy5pGsn4Cfrkgh5JuDv6+lg0p/au4T/xVkgWwJUxMFTHa02KZb\n\tLyGWWQcvEYBRQLN2Wvwm7lIvr9ALnZtB6l9/dWq8="],"Authentication-Results":"lancelot.ideasonboard.com; dkim=pass (1024-bit key; \n\tunprotected) header.d=ideasonboard.com\n\theader.i=@ideasonboard.com\n\theader.b=\"GHcLgs0M\"; dkim-atps=neutral","Content-Type":"text/plain; charset=\"utf-8\"","MIME-Version":"1.0","Content-Transfer-Encoding":"quoted-printable","In-Reply-To":"<20221019110434.17767-2-laurent.pinchart@ideasonboard.com>","References":"<20221019110434.17767-1-laurent.pinchart@ideasonboard.com>\n\t<20221019110434.17767-2-laurent.pinchart@ideasonboard.com>","To":"Laurent Pinchart ,\n\tlibcamera-devel@lists.libcamera.org","Date":"Wed, 19 Oct 2022 12:27:04 +0100","Message-ID":"<166617882484.2560709.18190382231598659150@Monstersaurus>","User-Agent":"alot/0.10","Subject":"Re: [libcamera-devel] [PATCH v1 1/4] ipa: Drop period at end of\n\t\\brief or \\param","X-BeenThere":"libcamera-devel@lists.libcamera.org","X-Mailman-Version":"2.1.29","Precedence":"list","List-Id":"","List-Unsubscribe":",\n\t","List-Archive":"","List-Post":"","List-Help":"","List-Subscribe":",\n\t","From":"Kieran Bingham via libcamera-devel\n\t","Reply-To":"Kieran Bingham ","Errors-To":"libcamera-devel-bounces@lists.libcamera.org","Sender":"\"libcamera-devel\" "}},{"id":25470,"web_url":"https://patchwork.libcamera.org/comment/25470/","msgid":"<20221019114401.x5543gmkmwag4xnr@uno.localdomain>","date":"2022-10-19T11:44:01","subject":"Re: [libcamera-devel] [PATCH v1 1/4] ipa: Drop period at end of\n\t\\brief or \\param","submitter":{"id":3,"url":"https://patchwork.libcamera.org/api/people/3/","name":"Jacopo Mondi","email":"jacopo@jmondi.org"},"content":"Hi Laurent\n\nOn Wed, Oct 19, 2022 at 02:04:31PM +0300, Laurent Pinchart via libcamera-devel wrote:\n> A few periods crept in at the end of Doxygen \\brief or \\param statements\n> in the src/ipa/ directory. Remove them all in one go.\n>\n> Signed-off-by: Laurent Pinchart \n\nThat's an easy one\nReviewed-by: Jacopo Mondi \n\nThanks\n j\n\n> ---\n> src/ipa/ipu3/algorithms/af.cpp | 18 +++++++++---------\n> src/ipa/ipu3/ipa_context.cpp | 6 +++---\n> src/ipa/libipa/algorithm.cpp | 2 +-\n> src/ipa/libipa/histogram.cpp | 2 +-\n> 4 files changed, 14 insertions(+), 14 deletions(-)\n>\n> diff --git a/src/ipa/ipu3/algorithms/af.cpp b/src/ipa/ipu3/algorithms/af.cpp\n> index b00a34f9e090..75632aa39d21 100644\n> --- a/src/ipa/ipu3/algorithms/af.cpp\n> +++ b/src/ipa/ipu3/algorithms/af.cpp\n> @@ -267,9 +267,9 @@ void Af::afReset(IPAContext &context)\n> }\n>\n> /**\n> - * \\brief AF variance comparison.\n> + * \\brief AF variance comparison\n> * \\param[in] context The IPA context\n> - * \\param[in] min_step The VCM movement step.\n> + * \\param[in] min_step The VCM movement step\n> *\n> * We always pick the largest variance to replace the previous one. The image\n> * with a larger variance also indicates it is a clearer image than previous\n> @@ -322,7 +322,7 @@ bool Af::afScan(IPAContext &context, int min_step)\n> }\n>\n> /**\n> - * \\brief Determine the frame to be ignored.\n> + * \\brief Determine the frame to be ignored\n> * \\return Return True if the frame should be ignored, false otherwise\n> */\n> bool Af::afNeedIgnoreFrame()\n> @@ -335,7 +335,7 @@ bool Af::afNeedIgnoreFrame()\n> }\n>\n> /**\n> - * \\brief Reset frame ignore counter.\n> + * \\brief Reset frame ignore counter\n> */\n> void Af::afIgnoreFrameReset()\n> {\n> @@ -377,8 +377,8 @@ double Af::afEstimateVariance(Span y_items, bool isY1)\n> }\n>\n> /**\n> - * \\brief Determine out-of-focus situation.\n> - * \\param[in] context The IPA context.\n> + * \\brief Determine out-of-focus situation\n> + * \\param[in] context The IPA context\n> *\n> * Out-of-focus means that the variance change rate for a focused and a new\n> * variance is greater than a threshold.\n> @@ -404,11 +404,11 @@ bool Af::afIsOutOfFocus(IPAContext &context)\n> }\n>\n> /**\n> - * \\brief Determine the max contrast image and lens position.\n> - * \\param[in] context The IPA context.\n> + * \\brief Determine the max contrast image and lens position\n> + * \\param[in] context The IPA context\n> * \\param[in] frame The frame context sequence number\n> * \\param[in] frameContext The current frame context\n> - * \\param[in] stats The statistics buffer of IPU3.\n> + * \\param[in] stats The statistics buffer of IPU3\n> *\n> * Ideally, a clear image also has a relatively higher contrast. So, every\n> * image for each focus step should be tested to find an optimal focus step.\n> diff --git a/src/ipa/ipu3/ipa_context.cpp b/src/ipa/ipu3/ipa_context.cpp\n> index f276227c1ecc..68f017b04751 100644\n> --- a/src/ipa/ipu3/ipa_context.cpp\n> +++ b/src/ipa/ipu3/ipa_context.cpp\n> @@ -68,7 +68,7 @@ namespace libcamera::ipa::ipu3 {\n> * \\brief AF grid configuration of the IPA\n> *\n> * \\var IPASessionConfiguration::af.afGrid\n> - * \\brief AF scene grid configuration.\n> + * \\brief AF scene grid configuration\n> */\n>\n> /**\n> @@ -79,10 +79,10 @@ namespace libcamera::ipa::ipu3 {\n> * \\brief Current position of the lens\n> *\n> * \\var IPAActiveState::af.maxVariance\n> - * \\brief The maximum variance of the current image.\n> + * \\brief The maximum variance of the current image\n> *\n> * \\var IPAActiveState::af.stable\n> - * \\brief It is set to true, if the best focus is found.\n> + * \\brief It is set to true, if the best focus is found\n> */\n>\n> /**\n> diff --git a/src/ipa/libipa/algorithm.cpp b/src/ipa/libipa/algorithm.cpp\n> index c152b885aee1..55abddab2b0a 100644\n> --- a/src/ipa/libipa/algorithm.cpp\n> +++ b/src/ipa/libipa/algorithm.cpp\n> @@ -72,7 +72,7 @@ namespace ipa {\n> * \\param[in] context The shared IPA context\n> * \\param[in] frame The frame context sequence number\n> * \\param[in] frameContext The FrameContext for this frame\n> - * \\param[out] params The ISP specific parameters.\n> + * \\param[out] params The ISP specific parameters\n> *\n> * This function is called for every frame when the camera is running before it\n> * is processed by the ISP to prepare the ISP processing parameters for that\n> diff --git a/src/ipa/libipa/histogram.cpp b/src/ipa/libipa/histogram.cpp\n> index 69b461779a1f..6b5cde8e0ab3 100644\n> --- a/src/ipa/libipa/histogram.cpp\n> +++ b/src/ipa/libipa/histogram.cpp\n> @@ -53,7 +53,7 @@ Histogram::Histogram(Span data)\n> */\n>\n> /**\n> - * \\brief Cumulative frequency up to a (fractional) point in a bin.\n> + * \\brief Cumulative frequency up to a (fractional) point in a bin\n> * \\param[in] bin The bin up to which to cumulate\n> *\n> * With F(p) the cumulative frequency of the histogram, the value is 0 at\n> --\n> Regards,\n>\n> Laurent Pinchart\n>","headers":{"Return-Path":"","X-Original-To":"parsemail@patchwork.libcamera.org","Delivered-To":"parsemail@patchwork.libcamera.org","Received":["from lancelot.ideasonboard.com (lancelot.ideasonboard.com\n\t[92.243.16.209])\n\tby patchwork.libcamera.org (Postfix) with ESMTPS id 3C14ABD16B\n\tfor ;\n\tWed, 19 Oct 2022 11:44:06 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id 02B4462E58;\n\tWed, 19 Oct 2022 13:44:06 +0200 (CEST)","from relay2-d.mail.gandi.net (relay2-d.mail.gandi.net\n\t[IPv6:2001:4b98:dc4:8::222])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id 9092062DFA\n\tfor ;\n\tWed, 19 Oct 2022 13:44:04 +0200 (CEST)","(Authenticated sender: jacopo@jmondi.org)\n\tby mail.gandi.net (Postfix) with ESMTPSA id DC59B4000B;\n\tWed, 19 Oct 2022 11:44:03 +0000 (UTC)"],"DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/simple; d=libcamera.org;\n\ts=mail; t=1666179846;\n\tbh=lxrmrjWfc+QRUrqviNAeENFyS4PmzCZWqgtjn1fbkPE=;\n\th=Date:To:References:In-Reply-To:Subject:List-Id:List-Unsubscribe:\n\tList-Archive:List-Post:List-Help:List-Subscribe:From:Reply-To:Cc:\n\tFrom;\n\tb=MFyRYBLgLAb1KppnybHaerWsy+/dLr7rdH1DbbOYamau5d0dI0VjUHhuXEfO+VZ2V\n\tF6pLKr9aMOY7IDb8b+1T/ZZnOLGWiHtwpfVEmxhtudZK668KRM+zjVbn3MQBlHuYOd\n\ty/94DPW8lmD1zByBmjSt86TP7MBgcWTIDVgjxE6of1R8CVI0zGdL0cagK4v751t97Q\n\tDGAQAwow+VN+cIcgki6AZ20HXtWa70vckIRgV5fq1QVlzLUIC5xx18GA91eQEwKpDo\n\td+vFbdphNH5/XfZbfceHXezkfn/ihPvEq7jT2BpUxhFgeYs9lB0anGPyAoPuc2nVLi\n\tqk95vgCEp0HiA==","Date":"Wed, 19 Oct 2022 13:44:01 +0200","To":"Laurent Pinchart ","Message-ID":"<20221019114401.x5543gmkmwag4xnr@uno.localdomain>","References":"<20221019110434.17767-1-laurent.pinchart@ideasonboard.com>\n\t<20221019110434.17767-2-laurent.pinchart@ideasonboard.com>","MIME-Version":"1.0","Content-Type":"text/plain; charset=utf-8","Content-Disposition":"inline","In-Reply-To":"<20221019110434.17767-2-laurent.pinchart@ideasonboard.com>","Subject":"Re: [libcamera-devel] [PATCH v1 1/4] ipa: Drop period at end of\n\t\\brief or \\param","X-BeenThere":"libcamera-devel@lists.libcamera.org","X-Mailman-Version":"2.1.29","Precedence":"list","List-Id":"","List-Unsubscribe":",\n\t","List-Archive":"","List-Post":"","List-Help":"","List-Subscribe":",\n\t","From":"Jacopo Mondi via libcamera-devel ","Reply-To":"Jacopo Mondi ","Cc":"libcamera-devel@lists.libcamera.org","Errors-To":"libcamera-devel-bounces@lists.libcamera.org","Sender":"\"libcamera-devel\" "}}]