{"id":14349,"url":"https://patchwork.libcamera.org/api/patches/14349/?format=json","web_url":"https://patchwork.libcamera.org/patch/14349/","project":{"id":1,"url":"https://patchwork.libcamera.org/api/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-17-jeanmichel.hautbois@ideasonboard.com>","date":"2021-10-26T11:23:37","name":"[libcamera-devel,v5,16/19] ipa: ipu3: Fix badly documented context variables","commit_ref":"9b5f9e648788d15b562d7999e04935ece07da256","pull_url":null,"state":"accepted","archived":false,"hash":"b49972dda68f42a30f0e2f7b22527c9dc0f8d6c8","submitter":{"id":75,"url":"https://patchwork.libcamera.org/api/people/75/?format=json","name":"Jean-Michel Hautbois","email":"jeanmichel.hautbois@ideasonboard.com"},"delegate":null,"mbox":"https://patchwork.libcamera.org/patch/14349/mbox/","series":[{"id":2658,"url":"https://patchwork.libcamera.org/api/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/14349/comments/","check":"pending","checks":"https://patchwork.libcamera.org/api/patches/14349/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 56D49BF415\n\tfor <parsemail@patchwork.libcamera.org>;\n\tTue, 26 Oct 2021 11:24:07 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id 0196E64893;\n\tTue, 26 Oct 2021 13:24:07 +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 DF2C86487D\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tTue, 26 Oct 2021 13:23:47 +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 8F578F7B;\n\tTue, 26 Oct 2021 13:23:47 +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=\"g/AoHgD8\"; dkim-atps=neutral","DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1635247427;\n\tbh=abOFK9TYbtC/GuVD0qHYqrfD54ddE0NvQw4SazfiJ1c=;\n\th=From:To:Cc:Subject:Date:In-Reply-To:References:From;\n\tb=g/AoHgD89rOE02C7tUHe2BteDTFs+9XFxV4aDyfCa7hmSiaoU9a3e2yb/CQbzCxPV\n\t7P+LcwXClIwZ1d1v7M+/vg9OKFCI5yd9Miec8bmzqiXJyioDCK2DoRYHsDbWtetQTv\n\teLHr+ARQO5J6nwYmiP624HiOdtM26KVUDU7Fr0zU=","From":"Jean-Michel Hautbois <jeanmichel.hautbois@ideasonboard.com>","To":"libcamera-devel@lists.libcamera.org","Date":"Tue, 26 Oct 2021 13:23:37 +0200","Message-Id":"<20211026112340.110169-17-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 16/19] ipa: ipu3: Fix badly documented\n\tcontext variables","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":"Doxygen warns us because the structures are referenced as \\struct while\nthey should be \\var. Fix it.\n\nSigned-off-by: Jean-Michel Hautbois <jeanmichel.hautbois@ideasonboard.com>\nReviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>\nReviewed-by: Kieran Bingham <kieran.bingham@ideasonboard.com>\n---\n src/ipa/ipu3/ipa_context.cpp | 10 +++++-----\n 1 file changed, 5 insertions(+), 5 deletions(-)","diff":"diff --git a/src/ipa/ipu3/ipa_context.cpp b/src/ipa/ipu3/ipa_context.cpp\nindex 94a5f7f6..e73ec248 100644\n--- a/src/ipa/ipu3/ipa_context.cpp\n+++ b/src/ipa/ipu3/ipa_context.cpp\n@@ -56,7 +56,7 @@ namespace libcamera::ipa::ipu3 {\n  */\n \n /**\n- * \\struct IPASessionConfiguration::grid\n+ * \\var IPASessionConfiguration::grid\n  * \\brief Grid configuration of the IPA\n  *\n  * \\var IPASessionConfiguration::grid::bdsGrid\n@@ -70,7 +70,7 @@ namespace libcamera::ipa::ipu3 {\n  */\n \n /**\n- * \\struct IPASessionConfiguration::agc\n+ * \\var IPASessionConfiguration::agc\n  * \\brief AGC parameters configuration of the IPA\n  *\n  * \\var IPASessionConfiguration::agc::minShutterSpeed\n@@ -87,7 +87,7 @@ namespace libcamera::ipa::ipu3 {\n  */\n \n /**\n- * \\struct IPAFrameContext::agc\n+ * \\var IPAFrameContext::agc\n  * \\brief Context for the Automatic Gain Control algorithm\n  *\n  * The exposure and gain determined are expected to be applied to the sensor\n@@ -103,7 +103,7 @@ namespace libcamera::ipa::ipu3 {\n  */\n \n /**\n- * \\struct IPAFrameContext::awb\n+ * \\var IPAFrameContext::awb\n  * \\brief Context for the Automatic White Balance algorithm\n  *\n  * \\struct IPAFrameContext::awb::gains\n@@ -120,7 +120,7 @@ namespace libcamera::ipa::ipu3 {\n  */\n \n /**\n- * \\struct IPAFrameContext::toneMapping\n+ * \\var IPAFrameContext::toneMapping\n  * \\brief Context for ToneMapping and Gamma control\n  *\n  * \\var IPAFrameContext::toneMapping::gamma\n","prefixes":["libcamera-devel","v5","16/19"]}