[{"id":33427,"web_url":"https://patchwork.libcamera.org/comment/33427/","msgid":"<7juqs7o3br4bc7twtfm6254vvw6qbzyyqqjqndky7ymhcvjdmu@jwo6ydilb5xy>","date":"2025-02-24T09:00:16","subject":"Re: [PATCH 03/15] libipa: awb: Follow function names with '()' in\n\tdoxygen documentation","submitter":{"id":184,"url":"https://patchwork.libcamera.org/api/people/184/","name":"Stefan Klug","email":"stefan.klug@ideasonboard.com"},"content":"Hi Laurent,\n\nThank you for the patch. \n\nOn Mon, Feb 24, 2025 at 01:03:51AM +0200, Laurent Pinchart wrote:\n> Function names are followed by parentheses in doxygen documentation\n> blocks as convention in libcamera. Add missing parentheses in the\n> AwbAlgorithm documentation.\n\nI wasn't aware of that.\n\nReviewed-by: Stefan Klug <stefan.klug@ideasonboard.com> \n\n> \n> Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>\n> ---\n>  src/ipa/libipa/awb.cpp | 14 +++++++-------\n>  1 file changed, 7 insertions(+), 7 deletions(-)\n> \n> diff --git a/src/ipa/libipa/awb.cpp b/src/ipa/libipa/awb.cpp\n> index 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> -- \n> Regards,\n> \n> Laurent Pinchart\n>","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 529A6C324E\n\tfor <parsemail@patchwork.libcamera.org>;\n\tMon, 24 Feb 2025 09:00:21 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id F20C5686CC;\n\tMon, 24 Feb 2025 10:00:20 +0100 (CET)","from perceval.ideasonboard.com (perceval.ideasonboard.com\n\t[IPv6:2001:4b98:dc2:55:216:3eff:fef7:d647])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id 1B127686A6\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tMon, 24 Feb 2025 10:00:20 +0100 (CET)","from ideasonboard.com (unknown\n\t[IPv6:2a00:6020:448c:6c00:c02b:2ffa:8001:90d4])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id D71DD455;\n\tMon, 24 Feb 2025 09:58:53 +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=\"ten+zZhR\"; dkim-atps=neutral","DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1740387534;\n\tbh=19zjBEMbqES7HRViovtXyuI1PNQXhd0/6aKiLOxZqqI=;\n\th=Date:From:To:Cc:Subject:References:In-Reply-To:From;\n\tb=ten+zZhRHKgS5qIJnPPGcIf5sdmJj6frnPjg+NTL5FkjVBunUosR5KtNAN7Qw9ROG\n\t/+W/7DWziDATQk9XvVUMH1Twhwk7ucrO+lmBR3RDh2sa8OzrjkmKkDMwYAwPWbtMMU\n\tjWQimQNfA3732cmx65Mq9Mkb7CWoKHCCTQiKp8ao=","Date":"Mon, 24 Feb 2025 10:00:16 +0100","From":"Stefan Klug <stefan.klug@ideasonboard.com>","To":"Laurent Pinchart <laurent.pinchart@ideasonboard.com>","Cc":"libcamera-devel@lists.libcamera.org","Subject":"Re: [PATCH 03/15] libipa: awb: Follow function names with '()' in\n\tdoxygen documentation","Message-ID":"<7juqs7o3br4bc7twtfm6254vvw6qbzyyqqjqndky7ymhcvjdmu@jwo6ydilb5xy>","References":"<20250223230403.1226-1-laurent.pinchart@ideasonboard.com>\n\t<20250223230403.1226-4-laurent.pinchart@ideasonboard.com>","MIME-Version":"1.0","Content-Type":"text/plain; charset=utf-8","Content-Disposition":"inline","In-Reply-To":"<20250223230403.1226-4-laurent.pinchart@ideasonboard.com>","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>"}}]