{"id":22825,"url":"https://patchwork.libcamera.org/api/1.1/patches/22825/?format=json","web_url":"https://patchwork.libcamera.org/patch/22825/","project":{"id":1,"url":"https://patchwork.libcamera.org/api/1.1/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":"<20250223230403.1226-4-laurent.pinchart@ideasonboard.com>","date":"2025-02-23T23:03:51","name":"[03/15] libipa: awb: Follow function names with '()' in doxygen documentation","commit_ref":null,"pull_url":null,"state":"accepted","archived":false,"hash":"9af504904c900b86ddb918957752fdf82fd3883f","submitter":{"id":2,"url":"https://patchwork.libcamera.org/api/1.1/people/2/?format=json","name":"Laurent Pinchart","email":"laurent.pinchart@ideasonboard.com"},"delegate":null,"mbox":"https://patchwork.libcamera.org/patch/22825/mbox/","series":[{"id":5012,"url":"https://patchwork.libcamera.org/api/1.1/series/5012/?format=json","web_url":"https://patchwork.libcamera.org/project/libcamera/list/?series=5012","date":"2025-02-23T23:03:48","name":"libipa: awb: Drive-by fixes","version":1,"mbox":"https://patchwork.libcamera.org/series/5012/mbox/"}],"comments":"https://patchwork.libcamera.org/api/patches/22825/comments/","check":"pending","checks":"https://patchwork.libcamera.org/api/patches/22825/checks/","tags":{},"headers":{"Return-Path":"<libcamera-devel-bounces@lists.libcamera.org>","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 4CA78BDB13\n\tfor <parsemail@patchwork.libcamera.org>;\n\tSun, 23 Feb 2025 23:04:35 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id BEA07686B9;\n\tMon, 24 Feb 2025 00:04:30 +0100 (CET)","from perceval.ideasonboard.com (perceval.ideasonboard.com\n\t[213.167.242.64])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id C58EA686B9\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tMon, 24 Feb 2025 00:04:24 +0100 (CET)","from pendragon.ideasonboard.com (81-175-209-231.bb.dnainternet.fi\n\t[81.175.209.231])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id 58C90353\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tMon, 24 Feb 2025 00:02:58 +0100 (CET)"],"Authentication-Results":"lancelot.ideasonboard.com; dkim=pass (1024-bit key;\n\tunprotected) header.d=ideasonboard.com header.i=@ideasonboard.com\n\theader.b=\"H1tw1Snx\"; dkim-atps=neutral","DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1740351778;\n\tbh=ueXtDkxH7HYe4b1so1xCO61Lf/G9waDNNVrKdvXPUvs=;\n\th=From:To:Subject:Date:In-Reply-To:References:From;\n\tb=H1tw1SnxSrkP3H74H6CdXcyLwXbsujjcEJoAyUwqGWNQZMdKzfcHMCPoHFqYL1nS6\n\tugvDeW/mUdtkBSYICcwes2X+98m8dW1dqJg0DExmOfWgIO2fYhquloWirgYl9Y2/HA\n\tyVrC3R9kpDYJzsQkpmNgpUlp4Qk/NJ+ShlS2jsp8=","From":"Laurent Pinchart <laurent.pinchart@ideasonboard.com>","To":"libcamera-devel@lists.libcamera.org","Subject":"[PATCH 03/15] libipa: awb: Follow function names with '()' in\n\tdoxygen documentation","Date":"Mon, 24 Feb 2025 01:03:51 +0200","Message-ID":"<20250223230403.1226-4-laurent.pinchart@ideasonboard.com>","X-Mailer":"git-send-email 2.45.3","In-Reply-To":"<20250223230403.1226-1-laurent.pinchart@ideasonboard.com>","References":"<20250223230403.1226-1-laurent.pinchart@ideasonboard.com>","MIME-Version":"1.0","Content-Transfer-Encoding":"8bit","X-BeenThere":"libcamera-devel@lists.libcamera.org","X-Mailman-Version":"2.1.29","Precedence":"list","List-Id":"<libcamera-devel.lists.libcamera.org>","List-Unsubscribe":"<https://lists.libcamera.org/options/libcamera-devel>,\n\t<mailto:libcamera-devel-request@lists.libcamera.org?subject=unsubscribe>","List-Archive":"<https://lists.libcamera.org/pipermail/libcamera-devel/>","List-Post":"<mailto:libcamera-devel@lists.libcamera.org>","List-Help":"<mailto:libcamera-devel-request@lists.libcamera.org?subject=help>","List-Subscribe":"<https://lists.libcamera.org/listinfo/libcamera-devel>,\n\t<mailto:libcamera-devel-request@lists.libcamera.org?subject=subscribe>","Errors-To":"libcamera-devel-bounces@lists.libcamera.org","Sender":"\"libcamera-devel\" <libcamera-devel-bounces@lists.libcamera.org>"},"content":"Function names are followed by parentheses in doxygen documentation\nblocks as convention in libcamera. Add missing parentheses in the\nAwbAlgorithm documentation.\n\nSigned-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>\n---\n src/ipa/libipa/awb.cpp | 14 +++++++-------\n 1 file changed, 7 insertions(+), 7 deletions(-)","diff":"diff --git a/src/ipa/libipa/awb.cpp b/src/ipa/libipa/awb.cpp\nindex dc672f129c4a..1adefa5bb929 100644\n--- a/src/ipa/libipa/awb.cpp\n+++ b/src/ipa/libipa/awb.cpp\n@@ -49,7 +49,7 @@ namespace ipa {\n  */\n \n /**\n- * \\fn AwbStats::computeColourError\n+ * \\fn AwbStats::computeColourError()\n  * \\brief Compute an error value for when the given gains would be applied\n  * \\param[in] gains The gains to apply\n  *\n@@ -65,7 +65,7 @@ namespace ipa {\n  */\n \n /**\n- * \\fn AwbStats::getRGBMeans\n+ * \\fn AwbStats::getRGBMeans()\n  * \\brief Get RGB means of the statistics\n  *\n  * Fetch the RGB means from the statistics. The values of each channel are\n@@ -85,7 +85,7 @@ namespace ipa {\n  */\n \n /**\n- * \\fn AwbAlgorithm::init\n+ * \\fn AwbAlgorithm::init()\n  * \\brief Initialize the algorithm with the given tuning data\n  * \\param[in] tuningData The tuning data to use for the algorithm\n  *\n@@ -93,7 +93,7 @@ namespace ipa {\n  */\n \n /**\n- * \\fn AwbAlgorithm::calculateAwb\n+ * \\fn AwbAlgorithm::calculateAwb()\n  * \\brief Calculate AWB data from the given statistics\n  * \\param[in] stats The statistics to use for the calculation\n  * \\param[in] lux The lux value of the scene\n@@ -106,7 +106,7 @@ namespace ipa {\n  */\n \n /**\n- * \\fn AwbAlgorithm::gainsFromColourTemperature\n+ * \\fn AwbAlgorithm::gainsFromColourTemperature()\n  * \\brief Compute white balance gains from a colour temperature\n  * \\param[in] colourTemperature The colour temperature in Kelvin\n  *\n@@ -118,14 +118,14 @@ namespace ipa {\n  */\n \n /**\n- * \\fn AwbAlgorithm::controls\n+ * \\fn AwbAlgorithm::controls()\n  * \\brief Get the controls info map for this algorithm\n  *\n  * \\return The controls info map\n  */\n \n /**\n- * \\fn AwbAlgorithm::handleControls\n+ * \\fn AwbAlgorithm::handleControls()\n  * \\param[in] controls The controls to handle\n  * \\brief Handle the controls supplied in a request\n  */\n","prefixes":["03/15"]}