From patchwork Thu Sep 30 09:55:09 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Jean-Michel Hautbois X-Patchwork-Id: 14011 Return-Path: X-Original-To: parsemail@patchwork.libcamera.org Delivered-To: parsemail@patchwork.libcamera.org Received: from lancelot.ideasonboard.com (lancelot.ideasonboard.com [92.243.16.209]) by patchwork.libcamera.org (Postfix) with ESMTPS id C143BC3243 for ; Thu, 30 Sep 2021 09:55:37 +0000 (UTC) Received: from lancelot.ideasonboard.com (localhost [IPv6:::1]) by lancelot.ideasonboard.com (Postfix) with ESMTP id 821E4691C8; Thu, 30 Sep 2021 11:55:37 +0200 (CEST) Authentication-Results: lancelot.ideasonboard.com; dkim=fail reason="signature verification failed" (1024-bit key; unprotected) header.d=ideasonboard.com header.i=@ideasonboard.com header.b="E6+eBIxC"; dkim-atps=neutral Received: from perceval.ideasonboard.com (perceval.ideasonboard.com [213.167.242.64]) by lancelot.ideasonboard.com (Postfix) with ESMTPS id 156A3691BE for ; Thu, 30 Sep 2021 11:55:21 +0200 (CEST) Received: from tatooine.ideasonboard.com (unknown [IPv6:2a01:e0a:169:7140:bab4:22c5:662d:e478]) by perceval.ideasonboard.com (Postfix) with ESMTPSA id EA7A52A8; Thu, 30 Sep 2021 11:55:19 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com; s=mail; t=1632995720; bh=ZDsC5U9elk9Kl89mk/8RV4aoN2ujV09pb+sjRK5GPHo=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=E6+eBIxCi6Wuq4VtWesda1impfZD9VL24Q47LESzit+okRh4jORfmuso1Ch8CT4EB n6eN/hO8qkPvj2W0Z2dfe+XvDtzIpqtU159+TrhL+iWLfDAql6tlRARg+FkfSlPZDa jrY8MUNbLnXu3XiFpphEaQZuC4Ro6YSVRe2Ig4A0= From: Jean-Michel Hautbois To: libcamera-devel@lists.libcamera.org Date: Thu, 30 Sep 2021 11:55:09 +0200 Message-Id: <20210930095513.76213-15-jeanmichel.hautbois@ideasonboard.com> X-Mailer: git-send-email 2.30.2 In-Reply-To: <20210930095513.76213-1-jeanmichel.hautbois@ideasonboard.com> References: <20210930095513.76213-1-jeanmichel.hautbois@ideasonboard.com> MIME-Version: 1.0 Subject: [libcamera-devel] [PATCH 14/18] ipa: ipu3: ipa_context: Fix doxygen references X-BeenThere: libcamera-devel@lists.libcamera.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: libcamera-devel-bounces@lists.libcamera.org Sender: "libcamera-devel" From: Kieran Bingham The IPAFrameContext use unamed structures to group items. Doxygen can not reference the member variables of the container structures through the variable names, and expects the structure type name. As this is not given, the structure variables are referenced from the parent structure. Remove the member name from the annonymous type to allow Doxygen to match the implementation from the documentation. Signed-off-by: Kieran Bingham --- src/ipa/ipu3/ipa_context.cpp | 19 +++++++++++-------- 1 file changed, 11 insertions(+), 8 deletions(-) diff --git a/src/ipa/ipu3/ipa_context.cpp b/src/ipa/ipu3/ipa_context.cpp index 40d79772..a38e6053 100644 --- a/src/ipa/ipu3/ipa_context.cpp +++ b/src/ipa/ipu3/ipa_context.cpp @@ -59,10 +59,10 @@ namespace libcamera::ipa::ipu3 { * \struct IPASessionConfiguration::grid * \brief Grid configuration of the IPA * - * \var IPASessionConfiguration::grid::bdsGrid + * \var IPASessionConfiguration::bdsGrid * \brief Bayer Down Scaler grid plane config used by the kernel * - * \var IPASessionConfiguration::grid::bdsOutputSize + * \var IPASessionConfiguration::bdsOutputSize * \brief BDS output size configured by the pipeline handler */ @@ -73,10 +73,10 @@ namespace libcamera::ipa::ipu3 { * The exposure and gain determined are expected to be applied to the sensor * at the earliest opportunity. * - * \var IPAFrameContext::agc::exposure + * \var IPAFrameContext::exposure * \brief Exposure time expressed as a number of lines * - * \var IPAFrameContext::agc::gain + * \var IPAFrameContext::gain * \brief Analogue gain multiplier * * The gain should be adapted to the sensor specific gain code before applying. @@ -89,13 +89,13 @@ namespace libcamera::ipa::ipu3 { * \struct IPAFrameContext::awb::gains * \brief White balance gains * - * \var IPAFrameContext::awb::gains::red + * \var IPAFrameContext::red * \brief White balance gain for R channel * - * \var IPAFrameContext::awb::gains::green + * \var IPAFrameContext::green * \brief White balance gain for G channel * - * \var IPAFrameContext::awb::gains::blue + * \var IPAFrameContext::blue * \brief White balance gain for B channel */ @@ -103,7 +103,10 @@ namespace libcamera::ipa::ipu3 { * \struct IPAFrameContext::toneMapping * \brief Context for ToneMapping and Gamma control * - * \var IPAFrameContext::toneMapping::gammaCorrection + * \var IPAFrameContext::gamma + * \brief Gamma value for the LUT + * + * \var IPAFrameContext::gammaCorrection * \brief Per-pixel tone mapping implemented as a LUT * * The LUT structure is defined by the IPU3 kernel interface. See