{"id":17634,"url":"https://patchwork.libcamera.org/api/patches/17634/?format=json","web_url":"https://patchwork.libcamera.org/patch/17634/","project":{"id":1,"url":"https://patchwork.libcamera.org/api/projects/1/?format=json","name":"libcamera","link_name":"libcamera","list_id":"libcamera_core","list_email":"libcamera-devel@lists.libcamera.org","web_url":"","scm_url":"","webscm_url":""},"msgid":"<20221019110434.17767-2-laurent.pinchart@ideasonboard.com>","date":"2022-10-19T11:04:31","name":"[libcamera-devel,v1,1/4] ipa: Drop period at end of \\brief or \\param","commit_ref":null,"pull_url":null,"state":"accepted","archived":false,"hash":"400a87b592d26c9e152898b5ac2ec70712def6b8","submitter":{"id":2,"url":"https://patchwork.libcamera.org/api/people/2/?format=json","name":"Laurent Pinchart","email":"laurent.pinchart@ideasonboard.com"},"delegate":null,"mbox":"https://patchwork.libcamera.org/patch/17634/mbox/","series":[{"id":3567,"url":"https://patchwork.libcamera.org/api/series/3567/?format=json","web_url":"https://patchwork.libcamera.org/project/libcamera/list/?series=3567","date":"2022-10-19T11:04:30","name":"ipa: Fill metadata in individual algorithms","version":1,"mbox":"https://patchwork.libcamera.org/series/3567/mbox/"}],"comments":"https://patchwork.libcamera.org/api/patches/17634/comments/","check":"pending","checks":"https://patchwork.libcamera.org/api/patches/17634/checks/","tags":{},"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 53491C327C\n\tfor ;\n\tWed, 19 Oct 2022 11:05:03 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id ECFC662E57;\n\tWed, 19 Oct 2022 13:05:02 +0200 (CEST)","from perceval.ideasonboard.com (perceval.ideasonboard.com\n\t[213.167.242.64])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id D39DF62E45\n\tfor ;\n\tWed, 19 Oct 2022 13:04:59 +0200 (CEST)","from pendragon.ideasonboard.com (62-78-145-57.bb.dnainternet.fi\n\t[62.78.145.57])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id 6BE7E5A4\n\tfor ;\n\tWed, 19 Oct 2022 13:04:59 +0200 (CEST)"],"DKIM-Signature":["v=1; a=rsa-sha256; c=relaxed/simple; d=libcamera.org;\n\ts=mail; t=1666177503;\n\tbh=6nurTBtSZIaANKgyuDwAbCr+Xxcu8zjq+5iaqFEwX5A=;\n\th=To:Date:In-Reply-To:References:Subject:List-Id:List-Unsubscribe:\n\tList-Archive:List-Post:List-Help:List-Subscribe:From:Reply-To:\n\tFrom;\n\tb=ol9uCOuL1mh6d+lwOxyZMj/LrDrO8qHYFH/sduWsxcEA8wX+cHRlOWnABggoNMpC4\n\tlSNdMl/M3ZABHuji8gtMr1Yr2xKGjvTk9YMd/qqNJj7Tez1gdXSFMiFiqK9J5XtDSP\n\tCe0MzJufsitxHR5urUSEhVXq+/6az81wB2M6+L59hdZl4LaAhgdkGrtM3F60WaKnFk\n\tbDH7/RcjkewBMP6LDO0cpiiE4ujMWlAiBCnu0q+1loOWhQAGo5V3SCaCtbdZnSrJTH\n\ts7ABwxzrcAa3cS1/MHBFZ1jYLMBJTT7imheOtqjDOkt8RHQUSXZvbNvT8bVTCZnjse\n\tHW9LCSwyqpjhw==","v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1666177499;\n\tbh=6nurTBtSZIaANKgyuDwAbCr+Xxcu8zjq+5iaqFEwX5A=;\n\th=From:To:Subject:Date:In-Reply-To:References:From;\n\tb=mE81KUxGYCnEe3og6eoQ6xm7Y0tyyPMqio1gyEdYDkdBG9Pi+m5KvfAJbB7iuzeBc\n\th6Y14eum/UMxXkhrpaQHbFosW9ZKZ9seSNtqVpAMe1vAl2XoiClX/9HIZBT0BbacNL\n\tEjSeXtAq5s/atVe+iLxEyyzhTPubgiYUd8zfugMw="],"Authentication-Results":"lancelot.ideasonboard.com; dkim=pass (1024-bit key; \n\tunprotected) header.d=ideasonboard.com\n\theader.i=@ideasonboard.com\n\theader.b=\"mE81KUxG\"; dkim-atps=neutral","To":"libcamera-devel@lists.libcamera.org","Date":"Wed, 19 Oct 2022 14:04:31 +0300","Message-Id":"<20221019110434.17767-2-laurent.pinchart@ideasonboard.com>","X-Mailer":"git-send-email 2.37.3","In-Reply-To":"<20221019110434.17767-1-laurent.pinchart@ideasonboard.com>","References":"<20221019110434.17767-1-laurent.pinchart@ideasonboard.com>","MIME-Version":"1.0","Content-Transfer-Encoding":"8bit","Subject":"[libcamera-devel] [PATCH v1 1/4] ipa: Drop period at end of \\brief\n\tor \\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":"Laurent Pinchart via libcamera-devel\n\t","Reply-To":"Laurent Pinchart ","Errors-To":"libcamera-devel-bounces@lists.libcamera.org","Sender":"\"libcamera-devel\" "},"content":"A few periods crept in at the end of Doxygen \\brief or \\param statements\nin the src/ipa/ directory. Remove them all in one go.\n\nSigned-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(-)","diff":"diff --git a/src/ipa/ipu3/algorithms/af.cpp b/src/ipa/ipu3/algorithms/af.cpp\nindex 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.\ndiff --git a/src/ipa/ipu3/ipa_context.cpp b/src/ipa/ipu3/ipa_context.cpp\nindex 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 /**\ndiff --git a/src/ipa/libipa/algorithm.cpp b/src/ipa/libipa/algorithm.cpp\nindex 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\ndiff --git a/src/ipa/libipa/histogram.cpp b/src/ipa/libipa/histogram.cpp\nindex 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","prefixes":["libcamera-devel","v1","1/4"]}