{"id":14352,"url":"https://patchwork.libcamera.org/api/1.1/patches/14352/?format=json","web_url":"https://patchwork.libcamera.org/patch/14352/","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":"<20211026112340.110169-20-jeanmichel.hautbois@ideasonboard.com>","date":"2021-10-26T11:23:40","name":"[libcamera-devel,v5,19/19] ipa: ipu3: ipa_context: Fix doxygen warnings","commit_ref":"40eb2309997806f8671d820af580073e4aaf20da","pull_url":null,"state":"accepted","archived":false,"hash":"b997188a399b4096fa2fc2e5f9e8e9c21b1f5f58","submitter":{"id":75,"url":"https://patchwork.libcamera.org/api/1.1/people/75/?format=json","name":"Jean-Michel Hautbois","email":"jeanmichel.hautbois@ideasonboard.com"},"delegate":null,"mbox":"https://patchwork.libcamera.org/patch/14352/mbox/","series":[{"id":2658,"url":"https://patchwork.libcamera.org/api/1.1/series/2658/?format=json","web_url":"https://patchwork.libcamera.org/project/libcamera/list/?series=2658","date":"2021-10-26T11:23:21","name":"Document IPU3 IPA","version":5,"mbox":"https://patchwork.libcamera.org/series/2658/mbox/"}],"comments":"https://patchwork.libcamera.org/api/patches/14352/comments/","check":"pending","checks":"https://patchwork.libcamera.org/api/patches/14352/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 1C600BF415\n\tfor ;\n\tTue, 26 Oct 2021 11:24:09 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id D125764890;\n\tTue, 26 Oct 2021 13:24:08 +0200 (CEST)","from perceval.ideasonboard.com (perceval.ideasonboard.com\n\t[213.167.242.64])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id 8B33164891\n\tfor ;\n\tTue, 26 Oct 2021 13:23:48 +0200 (CEST)","from tatooine.ideasonboard.com (unknown\n\t[IPv6:2a01:e0a:169:7140:dce3:eb54:18d7:6f3d])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id 3A4E3E79;\n\tTue, 26 Oct 2021 13:23:48 +0200 (CEST)"],"Authentication-Results":"lancelot.ideasonboard.com;\n\tdkim=fail reason=\"signature verification failed\" (1024-bit key;\n\tunprotected) header.d=ideasonboard.com header.i=@ideasonboard.com\n\theader.b=\"TSsrYG0B\"; dkim-atps=neutral","DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1635247428;\n\tbh=ycdYbtWvxoVukojwfHHcE1kt6ctnxNoh1EvsFmhSnjc=;\n\th=From:To:Cc:Subject:Date:In-Reply-To:References:From;\n\tb=TSsrYG0BMvCadwH6xDrLhi+1KFUqDd/2zpATJplkhpsDKqVOMp2fbk51PzH3qZ97v\n\tMrc80p2sK/f/XrYYXKhCYX0FzgV3KFBF/jUziLVV36Qxfi7FmzFt5WxTlDHS55RqM0\n\tiUv7kpMzv1z9IKFDGRtySt5gamn9y/DKVHkWI0UY=","From":"Jean-Michel Hautbois ","To":"libcamera-devel@lists.libcamera.org","Date":"Tue, 26 Oct 2021 13:23:40 +0200","Message-Id":"<20211026112340.110169-20-jeanmichel.hautbois@ideasonboard.com>","X-Mailer":"git-send-email 2.32.0","In-Reply-To":"<20211026112340.110169-1-jeanmichel.hautbois@ideasonboard.com>","References":"<20211026112340.110169-1-jeanmichel.hautbois@ideasonboard.com>","MIME-Version":"1.0","Content-Transfer-Encoding":"8bit","Subject":"[libcamera-devel] [PATCH v5 19/19] ipa: ipu3: ipa_context: Fix\n\tdoxygen warnings","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\" "},"content":"From: Kieran Bingham \n\nThe IPAFrameContext uses unnamed structures to group items. Doxygen\ndoesn't seem to support this properly, documentation isn't properly\ngenerated and warnings are output during compilation. Suppress the\nwarning with a workaround that still results in incorrect generated\ndocumentation until Doxygen gets fixed.\n\nSigned-off-by: Kieran Bingham \n[JMH: Fix doxygen variable usage]\nSigned-off-by: Jean-Michel Hautbois \nReviewed-by: Umang Jain \nReviewed-by: Laurent Pinchart \nReviewed-by: Kieran Bingham \n---\n src/ipa/ipu3/ipa_context.cpp | 30 +++++++++++++++---------------\n 1 file changed, 15 insertions(+), 15 deletions(-)","diff":"diff --git a/src/ipa/ipu3/ipa_context.cpp b/src/ipa/ipu3/ipa_context.cpp\nindex e73ec248..2355a9c7 100644\n--- a/src/ipa/ipu3/ipa_context.cpp\n+++ b/src/ipa/ipu3/ipa_context.cpp\n@@ -59,13 +59,13 @@ namespace libcamera::ipa::ipu3 {\n * \\var IPASessionConfiguration::grid\n * \\brief Grid configuration of the IPA\n *\n- * \\var IPASessionConfiguration::grid::bdsGrid\n+ * \\var IPASessionConfiguration::grid.bdsGrid\n * \\brief Bayer Down Scaler grid plane config used by the kernel\n *\n- * \\var IPASessionConfiguration::grid::bdsOutputSize\n+ * \\var IPASessionConfiguration::grid.bdsOutputSize\n * \\brief BDS output size configured by the pipeline handler\n *\n- * \\var IPASessionConfiguration::grid::stride\n+ * \\var IPASessionConfiguration::grid.stride\n * \\brief Number of cells on one line including the ImgU padding\n */\n \n@@ -73,16 +73,16 @@ namespace libcamera::ipa::ipu3 {\n * \\var IPASessionConfiguration::agc\n * \\brief AGC parameters configuration of the IPA\n *\n- * \\var IPASessionConfiguration::agc::minShutterSpeed\n+ * \\var IPASessionConfiguration::agc.minShutterSpeed\n * \\brief Minimum shutter speed supported with the configured sensor\n *\n- * \\var IPASessionConfiguration::grid::maxShutterSpeed\n+ * \\var IPASessionConfiguration::grid.maxShutterSpeed\n * \\brief Maximum shutter speed supported with the configured sensor\n *\n- * \\var IPASessionConfiguration::grid::minAnalogueGain\n+ * \\var IPASessionConfiguration::grid.minAnalogueGain\n * \\brief Minimum analogue gain supported with the configured sensor\n *\n- * \\var IPASessionConfiguration::grid::maxAnalogueGain\n+ * \\var IPASessionConfiguration::grid.maxAnalogueGain\n * \\brief Maximum analogue gain supported with the configured sensor\n */\n \n@@ -93,10 +93,10 @@ namespace libcamera::ipa::ipu3 {\n * The exposure and gain determined are expected to be applied to the sensor\n * at the earliest opportunity.\n *\n- * \\var IPAFrameContext::agc::exposure\n+ * \\var IPAFrameContext::agc.exposure\n * \\brief Exposure time expressed as a number of lines\n *\n- * \\var IPAFrameContext::agc::gain\n+ * \\var IPAFrameContext::agc.gain\n * \\brief Analogue gain multiplier\n *\n * The gain should be adapted to the sensor specific gain code before applying.\n@@ -106,16 +106,16 @@ namespace libcamera::ipa::ipu3 {\n * \\var IPAFrameContext::awb\n * \\brief Context for the Automatic White Balance algorithm\n *\n- * \\struct IPAFrameContext::awb::gains\n+ * \\struct IPAFrameContext::awb.gains\n * \\brief White balance gains\n *\n- * \\var IPAFrameContext::awb::gains::red\n+ * \\var IPAFrameContext::awb.gains.red\n * \\brief White balance gain for R channel\n *\n- * \\var IPAFrameContext::awb::gains::green\n+ * \\var IPAFrameContext::awb.gains.green\n * \\brief White balance gain for G channel\n *\n- * \\var IPAFrameContext::awb::gains::blue\n+ * \\var IPAFrameContext::awb.gains.blue\n * \\brief White balance gain for B channel\n */\n \n@@ -123,10 +123,10 @@ namespace libcamera::ipa::ipu3 {\n * \\var IPAFrameContext::toneMapping\n * \\brief Context for ToneMapping and Gamma control\n *\n- * \\var IPAFrameContext::toneMapping::gamma\n+ * \\var IPAFrameContext::toneMapping.gamma\n * \\brief Gamma value for the LUT\n *\n- * \\var IPAFrameContext::toneMapping::gammaCorrection\n+ * \\var IPAFrameContext::toneMapping.gammaCorrection\n * \\brief Per-pixel tone mapping implemented as a LUT\n *\n * The LUT structure is defined by the IPU3 kernel interface. See\n","prefixes":["libcamera-devel","v5","19/19"]}