[{"id":29520,"web_url":"https://patchwork.libcamera.org/comment/29520/","msgid":"<45822ad0-88d4-4537-8ac2-fdaaa123264b@ideasonboard.com>","date":"2024-05-13T12:23:26","subject":"Re: [PATCH] ipa: libipa: histogram: Fix documentation of constructor","submitter":{"id":86,"url":"https://patchwork.libcamera.org/api/people/86/","name":"Umang Jain","email":"umang.jain@ideasonboard.com"},"content":"Hi Laurent,\n\nThank you for the fix.\n\nOn 13/05/24 5:46 pm, Laurent Pinchart wrote:\n> Commit 1dc01bc9e6c3 (\"ipa: libipa: histogram: Add transform parameter to\n> constructor\") added a new constructor for the Histogram class. The\n> implementation is inline in the header file, and the documentation was\n> added in the corresponding .cpp file, but it messed the \\fn directive.\n> This causes Doxygen to complain:\n>\n> src/ipa/libipa/histogram.h:31: warning: Member Histogram(Span< const uint32_t > data, Transform transform) (function) of class libcamera::ipa::Histogram is not documented.\n> src/ipa/libipa/histogram.cpp:59: warning: libcamera::ipa::Histogram::bins has @param documentation sections but no arguments\n>\n> Fix it.\n>\n> Fixes: 1dc01bc9e6c3 (\"ipa: libipa: histogram: Add transform parameter to constructor\")\n> Signed-off-by: Laurent Pinchart \n\nReviewed-by: Umang Jain \n> ---\n> src/ipa/libipa/histogram.cpp | 1 +\n> 1 file changed, 1 insertion(+)\n>\n> diff --git a/src/ipa/libipa/histogram.cpp b/src/ipa/libipa/histogram.cpp\n> index 633dbd052c1c..5fbfadf5e4e1 100644\n> --- a/src/ipa/libipa/histogram.cpp\n> +++ b/src/ipa/libipa/histogram.cpp\n> @@ -50,6 +50,7 @@ Histogram::Histogram(Span data)\n> }\n> \n> /**\n> + * \\fn Histogram::Histogram(Span data, Transform transform)\n> * \\brief Create a cumulative histogram\n> * \\param[in] data A (non-cumulative) histogram\n> * \\param[in] transform The transformation function to apply to every bin\n>\n> base-commit: 3cb20bc2301c03d01a631eb637ab47031d2b91e6","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 4A505C3226\n\tfor ;\n\tMon, 13 May 2024 12:23:35 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id DE8196346B;\n\tMon, 13 May 2024 14:23:33 +0200 (CEST)","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 E662E61A5E\n\tfor ;\n\tMon, 13 May 2024 14:23:31 +0200 (CEST)","from [IPV6:2405:201:2015:f05b:2688:8900:ad4d:c237] (unknown\n\t[IPv6:2405:201:2015:f05b:2688:8900:ad4d:c237])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id EF6EDCC8;\n\tMon, 13 May 2024 14:23:24 +0200 (CEST)"],"Authentication-Results":"lancelot.ideasonboard.com; dkim=pass (1024-bit key;\n\tunprotected) header.d=ideasonboard.com header.i=@ideasonboard.com\n\theader.b=\"TYy07FHa\"; dkim-atps=neutral","DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1715603005;\n\tbh=NrO3W0QY1SCdJWlTC9EOAaRtziyS8pcQFjZIBx5ylLg=;\n\th=Date:Subject:To:References:From:In-Reply-To:From;\n\tb=TYy07FHaDVEkNOtzpE3QHjMw+uYRreu5HJVB7776ex9kNEaP6gLIm2CApJQ+HARh/\n\tu/SLzyLSk6ZF1MCgWf7UiD5U1/h8wl4RncBEHK1/Mer5SgAqJiOvGQ1CisGrFxBtNq\n\tOP6y1wY2cdBBhA+V+gLEV0HRoKnydEt6Xxlp2WSI=","Message-ID":"<45822ad0-88d4-4537-8ac2-fdaaa123264b@ideasonboard.com>","Date":"Mon, 13 May 2024 17:53:26 +0530","MIME-Version":"1.0","User-Agent":"Mozilla Thunderbird","Subject":"Re: [PATCH] ipa: libipa: histogram: Fix documentation of constructor","To":"Laurent Pinchart ,\n\tlibcamera-devel@lists.libcamera.org","References":"<20240513121645.2891-1-laurent.pinchart@ideasonboard.com>","Content-Language":"en-US","From":"Umang Jain ","In-Reply-To":"<20240513121645.2891-1-laurent.pinchart@ideasonboard.com>","Content-Type":"text/plain; charset=UTF-8; format=flowed","Content-Transfer-Encoding":"7bit","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","Errors-To":"libcamera-devel-bounces@lists.libcamera.org","Sender":"\"libcamera-devel\" "}},{"id":29521,"web_url":"https://patchwork.libcamera.org/comment/29521/","msgid":"<20240513124109.oj65pyr46plbturc@jasper>","date":"2024-05-13T12:41:09","subject":"Re: [PATCH] ipa: libipa: histogram: Fix documentation of constructor","submitter":{"id":184,"url":"https://patchwork.libcamera.org/api/people/184/","name":"Stefan Klug","email":"stefan.klug@ideasonboard.com"},"content":"Hi Laurent,\n\nthanks for the patch.\n\nOn Mon, May 13, 2024 at 03:16:45PM +0300, Laurent Pinchart wrote:\n> Commit 1dc01bc9e6c3 (\"ipa: libipa: histogram: Add transform parameter to\n> constructor\") added a new constructor for the Histogram class. The\n> implementation is inline in the header file, and the documentation was\n> added in the corresponding .cpp file, but it messed the \\fn directive.\n\nnit: s/messed/missed/\n\n> This causes Doxygen to complain:\n> \n> src/ipa/libipa/histogram.h:31: warning: Member Histogram(Span< const uint32_t > data, Transform transform) (function) of class libcamera::ipa::Histogram is not documented.\n> src/ipa/libipa/histogram.cpp:59: warning: libcamera::ipa::Histogram::bins has @param documentation sections but no arguments\n> \n> Fix it.\n> \n> Fixes: 1dc01bc9e6c3 (\"ipa: libipa: histogram: Add transform parameter to constructor\")\n> Signed-off-by: Laurent Pinchart \n\nReviewed-by: Stefan Klug \n\nCheers,\nStefan\n\n> ---\n> src/ipa/libipa/histogram.cpp | 1 +\n> 1 file changed, 1 insertion(+)\n> \n> diff --git a/src/ipa/libipa/histogram.cpp b/src/ipa/libipa/histogram.cpp\n> index 633dbd052c1c..5fbfadf5e4e1 100644\n> --- a/src/ipa/libipa/histogram.cpp\n> +++ b/src/ipa/libipa/histogram.cpp\n> @@ -50,6 +50,7 @@ Histogram::Histogram(Span data)\n> }\n> \n> /**\n> + * \\fn Histogram::Histogram(Span data, Transform transform)\n> * \\brief Create a cumulative histogram\n> * \\param[in] data A (non-cumulative) histogram\n> * \\param[in] transform The transformation function to apply to every bin\n> \n> base-commit: 3cb20bc2301c03d01a631eb637ab47031d2b91e6\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 2C15BBDE6B\n\tfor ;\n\tMon, 13 May 2024 12:41:15 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id 5B08861A64;\n\tMon, 13 May 2024 14:41:14 +0200 (CEST)","from perceval.ideasonboard.com (perceval.ideasonboard.com\n\t[213.167.242.64])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id B6EF761A5E\n\tfor ;\n\tMon, 13 May 2024 14:41:12 +0200 (CEST)","from ideasonboard.com (unknown\n\t[IPv6:2a00:6020:448c:6c00:ff8b:391c:44ce:a799])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id 3A4B0CC8;\n\tMon, 13 May 2024 14:41:06 +0200 (CEST)"],"Authentication-Results":"lancelot.ideasonboard.com; dkim=pass (1024-bit key;\n\tunprotected) header.d=ideasonboard.com header.i=@ideasonboard.com\n\theader.b=\"VWSbyUXO\"; dkim-atps=neutral","DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1715604066;\n\tbh=3ZhAgkdBL6aVCL8STbL7EGmM7HwNb8j2E6UI5TbR05o=;\n\th=Date:From:To:Cc:Subject:References:In-Reply-To:From;\n\tb=VWSbyUXONdnJ+kQ0L8wPipUP5u4ATMmIPLeU5N0K4yBKrvbYMqya3O0CffV1CSsWP\n\tiA3zWCG8Cnk9N/BH2IjIn0sy63yjyhmM4m8wA08G2qnWjIGV1CYV9qWBzSsKuPXyDj\n\toBGsQzJp+bfs+pd9tRUg4bLToa7UPrakJAtSz9tg=","Date":"Mon, 13 May 2024 14:41:09 +0200","From":"Stefan Klug ","To":"Laurent Pinchart ","Cc":"libcamera-devel@lists.libcamera.org","Subject":"Re: [PATCH] ipa: libipa: histogram: Fix documentation of constructor","Message-ID":"<20240513124109.oj65pyr46plbturc@jasper>","References":"<20240513121645.2891-1-laurent.pinchart@ideasonboard.com>","MIME-Version":"1.0","Content-Type":"text/plain; charset=utf-8","Content-Disposition":"inline","In-Reply-To":"<20240513121645.2891-1-laurent.pinchart@ideasonboard.com>","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","Errors-To":"libcamera-devel-bounces@lists.libcamera.org","Sender":"\"libcamera-devel\" "}}]