[{"id":22990,"web_url":"https://patchwork.libcamera.org/comment/22990/","msgid":"","date":"2022-05-17T14:20:22","subject":"Re: [libcamera-devel] [PATCH] ipa: ipu3: Fix minor Doxygen issues\n\tin IPAFrameContext","submitter":{"id":2,"url":"https://patchwork.libcamera.org/api/people/2/","name":"Laurent Pinchart","email":"laurent.pinchart@ideasonboard.com"},"content":"On Tue, May 17, 2022 at 05:18:40PM +0300, Laurent Pinchart via libcamera-devel wrote:\n> The IPAFrameContext documentation has a spurious Doxygen \\struct\n> statement that is not needed, and uses a \\struct instead of a \\var in\n> another location. Fix both issues. This doesn't cause any change in the\n> generated documentation.\n\nNote that the Doxygen output for IPAFrameContext is incorrect,\ndocumentation is missing for all members. This is caused by using \".\"\ninstead of \"::\" in our documentation, which we currently do because the\ncorrect syntax produces Doxygen warnings (and still incorrect output).\nSee https://github.com/doxygen/doxygen/issues/9343.\n\n> Signed-off-by: Laurent Pinchart \n> ---\n> src/ipa/ipu3/ipa_context.cpp | 3 +--\n> 1 file changed, 1 insertion(+), 2 deletions(-)\n> \n> diff --git a/src/ipa/ipu3/ipa_context.cpp b/src/ipa/ipu3/ipa_context.cpp\n> index b1570dde7fe4..26e74c747877 100644\n> --- a/src/ipa/ipu3/ipa_context.cpp\n> +++ b/src/ipa/ipu3/ipa_context.cpp\n> @@ -81,7 +81,6 @@ namespace libcamera::ipa::ipu3 {\n> * \\var IPAFrameContext::af\n> * \\brief Context for the Automatic Focus algorithm\n> *\n> - * \\struct IPAFrameContext::af\n> * \\var IPAFrameContext::af.focus\n> * \\brief Current position of the lens\n> *\n> @@ -140,7 +139,7 @@ namespace libcamera::ipa::ipu3 {\n> * \\var IPAFrameContext::awb\n> * \\brief Context for the Automatic White Balance algorithm\n> *\n> - * \\struct IPAFrameContext::awb.gains\n> + * \\var IPAFrameContext::awb.gains\n> * \\brief White balance gains\n> *\n> * \\var IPAFrameContext::awb.gains.red\n> \n> base-commit: 5efb6c8e2acdc2dc9edf1f22f6c2a5818062b69e","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 4F4EBC0F2A\n\tfor ;\n\tTue, 17 May 2022 14:20:31 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id 1201A65659;\n\tTue, 17 May 2022 16:20:31 +0200 (CEST)","from perceval.ideasonboard.com (perceval.ideasonboard.com\n\t[213.167.242.64])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id 75E376041D\n\tfor ;\n\tTue, 17 May 2022 16:20:29 +0200 (CEST)","from pendragon.ideasonboard.com (unknown [45.131.31.124])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id 0B9004A8\n\tfor ;\n\tTue, 17 May 2022 16:20:28 +0200 (CEST)"],"DKIM-Signature":["v=1; a=rsa-sha256; c=relaxed/simple; d=libcamera.org;\n\ts=mail; t=1652797231;\n\tbh=Dax8oArrZ4OlQWx3+juqJvL2qy/Qx7XNNTEUDaJjPhA=;\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:\n\tFrom;\n\tb=Lc6h0qfQbHqTK74zXX607vagNx/AhQ/+QASkmh81nuWwr7j9LRykmFBNmOHMSzKeA\n\tIigLnHVW9T/CtxeqreekgEN89FpNI40zz7DYmfLfwhopKM/38TqoouGIIl4a6oezMw\n\twtZtUoRxHx3KmRcC/Gkss5CAvB5WGZpHUMHm+4TUcGDDMnFDWBFF5HZIMMfNNeo4DU\n\tnYfbGnHYufC0uL4SG9llJ7J7IwZn9ALeimKbkjfVMtsj+Kd9hzsrpY+JMUWOIL4PYq\n\tDvFAoMa5oVbchYiBv6zw8jUMMedsEoljo7jjlcXZVGbJeVKMlo+p+E7pGRnslet9UJ\n\tyDDkJLdsGsvdw==","v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1652797229;\n\tbh=Dax8oArrZ4OlQWx3+juqJvL2qy/Qx7XNNTEUDaJjPhA=;\n\th=Date:From:To:Subject:References:In-Reply-To:From;\n\tb=S5zzm2cBIUZPALGCFqJybk2XWxzKDpZzvr3BbwFloU+mPV+hviLCWvEJInaE65N5E\n\tSmzD9EjTwh8X5ejPXqqp+jeKmHgcrg+3G+LQa32WMZOsgPPa6+nXLtO4rsrG0KAGsV\n\t/T4EbV3fSDyMCJuuksir36fhZUYEsh41tJBrmdII="],"Authentication-Results":"lancelot.ideasonboard.com; dkim=pass (1024-bit key; \n\tunprotected) header.d=ideasonboard.com\n\theader.i=@ideasonboard.com\n\theader.b=\"S5zzm2cB\"; dkim-atps=neutral","Date":"Tue, 17 May 2022 17:20:22 +0300","To":"libcamera-devel@lists.libcamera.org","Message-ID":"","References":"<20220517141840.9329-1-laurent.pinchart@ideasonboard.com>","MIME-Version":"1.0","Content-Type":"text/plain; charset=utf-8","Content-Disposition":"inline","In-Reply-To":"<20220517141840.9329-1-laurent.pinchart@ideasonboard.com>","Subject":"Re: [libcamera-devel] [PATCH] ipa: ipu3: Fix minor Doxygen issues\n\tin IPAFrameContext","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\" "}},{"id":23005,"web_url":"https://patchwork.libcamera.org/comment/23005/","msgid":"<165280588762.2416244.8615838310647269965@Monstersaurus>","date":"2022-05-17T16:44:47","subject":"Re: [libcamera-devel] [PATCH] ipa: ipu3: Fix minor Doxygen issues\n\tin IPAFrameContext","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-05-17 15:18:40)\n> The IPAFrameContext documentation has a spurious Doxygen \\struct\n> statement that is not needed, and uses a \\struct instead of a \\var in\n> another location. Fix both issues. This doesn't cause any change in the\n> generated documentation.\n> \n\nI'd be tempted to reference the known issue and reported bug on doxygen\nhere, but it doesn't matter so much.\n\n\nReviewed-by: Kieran Bingham \n\n> Signed-off-by: Laurent Pinchart \n> ---\n> src/ipa/ipu3/ipa_context.cpp | 3 +--\n> 1 file changed, 1 insertion(+), 2 deletions(-)\n> \n> diff --git a/src/ipa/ipu3/ipa_context.cpp b/src/ipa/ipu3/ipa_context.cpp\n> index b1570dde7fe4..26e74c747877 100644\n> --- a/src/ipa/ipu3/ipa_context.cpp\n> +++ b/src/ipa/ipu3/ipa_context.cpp\n> @@ -81,7 +81,6 @@ namespace libcamera::ipa::ipu3 {\n> * \\var IPAFrameContext::af\n> * \\brief Context for the Automatic Focus algorithm\n> *\n> - * \\struct IPAFrameContext::af\n> * \\var IPAFrameContext::af.focus\n> * \\brief Current position of the lens\n> *\n> @@ -140,7 +139,7 @@ namespace libcamera::ipa::ipu3 {\n> * \\var IPAFrameContext::awb\n> * \\brief Context for the Automatic White Balance algorithm\n> *\n> - * \\struct IPAFrameContext::awb.gains\n> + * \\var IPAFrameContext::awb.gains\n> * \\brief White balance gains\n> *\n> * \\var IPAFrameContext::awb.gains.red\n> \n> base-commit: 5efb6c8e2acdc2dc9edf1f22f6c2a5818062b69e\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 5AAB6C0F2A\n\tfor ;\n\tTue, 17 May 2022 16:44:53 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id B37C365656;\n\tTue, 17 May 2022 18:44:52 +0200 (CEST)","from perceval.ideasonboard.com (perceval.ideasonboard.com\n\t[213.167.242.64])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id DB14D6041D\n\tfor ;\n\tTue, 17 May 2022 18:44:50 +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 715E64A8;\n\tTue, 17 May 2022 18:44:50 +0200 (CEST)"],"DKIM-Signature":["v=1; a=rsa-sha256; c=relaxed/simple; d=libcamera.org;\n\ts=mail; t=1652805892;\n\tbh=nMvf79h/5bcTv4V5weXngipQaO3HKi2GtGU7+1gH6q0=;\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=FOn90Ft4gyiFyh/YP85JTVt7SSlnD/JhMbWLNgjoNhAItCVcQ/Or9nAh8GyCJv/yY\n\toaM81vT/ntBjGAzZACXPOVEeO47TQgi5D840lYfwVfA8B225bJohGWFvDnASnJWxNj\n\tyULm2U1ceVUfQc8Vd5WjTqfKLyyspu7qCW/YIRlM3iqZFj8HXhf1P6ZOYGqekC8eeO\n\tuhe+8PdeLBos//0aGNlHi6ozVl/6Dr5HE2wDZ+/zoJY9E7w19Nu0MZndrKu6AF65rl\n\tZsVeWGgXmIJARHfh/1JD+/YhNYBOdeAY1rPwboesbG0fu4LHy0NUrisyThtS5/u/n7\n\tT6htmeytBvc1g==","v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1652805890;\n\tbh=nMvf79h/5bcTv4V5weXngipQaO3HKi2GtGU7+1gH6q0=;\n\th=In-Reply-To:References:Subject:From:To:Date:From;\n\tb=A4aVOZjvWePIAd4EDY3B72Zwz3skcepX5HNQ3yh1X1841HkpMQ4PZQkpTn4Tx7ip/\n\tNouQhx3Nhy/2wDhLzc/ZbZzrfTtbnv99JO3kMzgUaKfEuOjUtRDuZP9Y+hPf3mbK6i\n\tn2DdqKO1LSrmidl2e60UnBQlcY+yoPzF/nBLSOzc="],"Authentication-Results":"lancelot.ideasonboard.com; dkim=pass (1024-bit key; \n\tunprotected) header.d=ideasonboard.com\n\theader.i=@ideasonboard.com\n\theader.b=\"A4aVOZjv\"; dkim-atps=neutral","Content-Type":"text/plain; charset=\"utf-8\"","MIME-Version":"1.0","Content-Transfer-Encoding":"quoted-printable","In-Reply-To":"<20220517141840.9329-1-laurent.pinchart@ideasonboard.com>","References":"<20220517141840.9329-1-laurent.pinchart@ideasonboard.com>","To":"Laurent Pinchart ,\n\tlibcamera-devel@lists.libcamera.org","Date":"Tue, 17 May 2022 17:44:47 +0100","Message-ID":"<165280588762.2416244.8615838310647269965@Monstersaurus>","User-Agent":"alot/0.10","Subject":"Re: [libcamera-devel] [PATCH] ipa: ipu3: Fix minor Doxygen issues\n\tin IPAFrameContext","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":23018,"web_url":"https://patchwork.libcamera.org/comment/23018/","msgid":"","date":"2022-05-17T17:31:43","subject":"Re: [libcamera-devel] [PATCH] ipa: ipu3: Fix minor Doxygen issues\n\tin IPAFrameContext","submitter":{"id":2,"url":"https://patchwork.libcamera.org/api/people/2/","name":"Laurent Pinchart","email":"laurent.pinchart@ideasonboard.com"},"content":"On Tue, May 17, 2022 at 05:20:22PM +0300, Laurent Pinchart via libcamera-devel wrote:\n> On Tue, May 17, 2022 at 05:18:40PM +0300, Laurent Pinchart via libcamera-devel wrote:\n> > The IPAFrameContext documentation has a spurious Doxygen \\struct\n> > statement that is not needed, and uses a \\struct instead of a \\var in\n> > another location. Fix both issues. This doesn't cause any change in the\n> > generated documentation.\n> \n> Note that the Doxygen output for IPAFrameContext is incorrect,\n> documentation is missing for all members. This is caused by using \".\"\n> instead of \"::\" in our documentation, which we currently do because the\n> correct syntax produces Doxygen warnings (and still incorrect output).\n> See https://github.com/doxygen/doxygen/issues/9343.\n\nI'll add this to the commit message verbatim, but won't send a v2 unless\nother changes are needed.\n\n> > Signed-off-by: Laurent Pinchart \n> > ---\n> > src/ipa/ipu3/ipa_context.cpp | 3 +--\n> > 1 file changed, 1 insertion(+), 2 deletions(-)\n> > \n> > diff --git a/src/ipa/ipu3/ipa_context.cpp b/src/ipa/ipu3/ipa_context.cpp\n> > index b1570dde7fe4..26e74c747877 100644\n> > --- a/src/ipa/ipu3/ipa_context.cpp\n> > +++ b/src/ipa/ipu3/ipa_context.cpp\n> > @@ -81,7 +81,6 @@ namespace libcamera::ipa::ipu3 {\n> > * \\var IPAFrameContext::af\n> > * \\brief Context for the Automatic Focus algorithm\n> > *\n> > - * \\struct IPAFrameContext::af\n> > * \\var IPAFrameContext::af.focus\n> > * \\brief Current position of the lens\n> > *\n> > @@ -140,7 +139,7 @@ namespace libcamera::ipa::ipu3 {\n> > * \\var IPAFrameContext::awb\n> > * \\brief Context for the Automatic White Balance algorithm\n> > *\n> > - * \\struct IPAFrameContext::awb.gains\n> > + * \\var IPAFrameContext::awb.gains\n> > * \\brief White balance gains\n> > *\n> > * \\var IPAFrameContext::awb.gains.red\n> > \n> > base-commit: 5efb6c8e2acdc2dc9edf1f22f6c2a5818062b69e","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 A992AC3256\n\tfor ;\n\tTue, 17 May 2022 17:31:52 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id 1E75A65656;\n\tTue, 17 May 2022 19:31:52 +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 0E6CC6041D\n\tfor ;\n\tTue, 17 May 2022 19:31:51 +0200 (CEST)","from pendragon.ideasonboard.com (unknown [45.131.31.124])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id 5384D4A8\n\tfor ;\n\tTue, 17 May 2022 19:31:50 +0200 (CEST)"],"DKIM-Signature":["v=1; a=rsa-sha256; c=relaxed/simple; d=libcamera.org;\n\ts=mail; t=1652808712;\n\tbh=mz3k7i8KKx7Zv30Kr+29/gOR2w9w1xEcIWQjKPkvzrs=;\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:\n\tFrom;\n\tb=2ULngo0FSnP4+ZERIYdjUt2rq/imLwpzka9x0DRbshqsHNwlo9CQ3ST4sO5sTC/Rw\n\tfqapJycc4w27znwOm9tRpuzWsTcz1qRyFqj6xhtq+gg+68Jpl1J6fPvBKEsatbXun8\n\tL1SaF21xQ3PXUvOPfHyKwieiBpwh26OO3OiGsUW8PdjOxKFGA00uTpocvDX6jb2nxq\n\tQsufGlGzsTMwUvJ9qEHt5qtxg5vju3i5m2rkrVw3vAdO/7VMWY2bHS5sJhLrMtCXPl\n\txe3yTvY23tc5ff/1gOCW63d9YePHprciuVZFAz6qLx0UJZK/et+pTBdBZPrVtdTrA4\n\tu06ennRf2PUNA==","v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1652808710;\n\tbh=mz3k7i8KKx7Zv30Kr+29/gOR2w9w1xEcIWQjKPkvzrs=;\n\th=Date:From:To:Subject:References:In-Reply-To:From;\n\tb=T7xCL1lgJ36jihEsaiBgzhyZe5LdB9LqlXCIaNKfba3zHAVY5XIHsZGq5IT98K9ZZ\n\tWISXFjjtDZpj/dqnb+xbi55qxhmW7fiK6VaCRXajxgL0mPve0s/whpZkC0Jn5PGHCI\n\t02fOvH9dcrjS/ySKhLWFBYNlAxy2LGvkXXA8FXfY="],"Authentication-Results":"lancelot.ideasonboard.com; dkim=pass (1024-bit key; \n\tunprotected) header.d=ideasonboard.com\n\theader.i=@ideasonboard.com\n\theader.b=\"T7xCL1lg\"; dkim-atps=neutral","Date":"Tue, 17 May 2022 20:31:43 +0300","To":"libcamera-devel@lists.libcamera.org","Message-ID":"","References":"<20220517141840.9329-1-laurent.pinchart@ideasonboard.com>\n\t","MIME-Version":"1.0","Content-Type":"text/plain; charset=utf-8","Content-Disposition":"inline","In-Reply-To":"","Subject":"Re: [libcamera-devel] [PATCH] ipa: ipu3: Fix minor Doxygen issues\n\tin IPAFrameContext","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\" "}}]