From patchwork Fri Oct 22 15:12:15 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: 14281 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 AA280C324E for ; Fri, 22 Oct 2021 15:12:42 +0000 (UTC) Received: from lancelot.ideasonboard.com (localhost [IPv6:::1]) by lancelot.ideasonboard.com (Postfix) with ESMTP id 5CC9C68F75; Fri, 22 Oct 2021 17:12:42 +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="GNqBR6KT"; dkim-atps=neutral Received: from perceval.ideasonboard.com (perceval.ideasonboard.com [213.167.242.64]) by lancelot.ideasonboard.com (Postfix) with ESMTPS id C975A68F5E for ; Fri, 22 Oct 2021 17:12:25 +0200 (CEST) Received: from tatooine.ideasonboard.com (unknown [IPv6:2a01:e0a:169:7140:22cc:3af6:5ccb:8367]) by perceval.ideasonboard.com (Postfix) with ESMTPSA id 7F95B1908; Fri, 22 Oct 2021 17:12:25 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com; s=mail; t=1634915545; bh=5k3kYHMCuwYrZSN313J2ZNP1pJd4igsh2RciCgr2y3g=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=GNqBR6KTBjfHRRJqqZ3O8KBezAk3zTtkhq1C4KNvXJtELsjMj1B18Q6oo6A+l5GpL hS6UEkao71F3T/KwitUYIgtcdSRUzM6dWvJU1HPpYFItbXOvq+xw3bTCwJzoY/PFpY 2aTAEOCBWDGvRwtZw+4lzc22gXnTF7QOiYtAImVg= From: Jean-Michel Hautbois To: libcamera-devel@lists.libcamera.org Date: Fri, 22 Oct 2021 17:12:15 +0200 Message-Id: <20211022151218.111966-17-jeanmichel.hautbois@ideasonboard.com> X-Mailer: git-send-email 2.32.0 In-Reply-To: <20211022151218.111966-1-jeanmichel.hautbois@ideasonboard.com> References: <20211022151218.111966-1-jeanmichel.hautbois@ideasonboard.com> MIME-Version: 1.0 Subject: [libcamera-devel] [PATCH v3 16/19] 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" 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 | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/src/ipa/ipu3/ipa_context.cpp b/src/ipa/ipu3/ipa_context.cpp index 3e154e60..3c5aa89a 100644 --- a/src/ipa/ipu3/ipa_context.cpp +++ b/src/ipa/ipu3/ipa_context.cpp @@ -59,13 +59,13 @@ 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 * - * \var IPASessionConfiguration::grid::stride + * \var IPASessionConfiguration::stride * \brief Number of cells on one line including the ImgU padding */ @@ -73,16 +73,16 @@ namespace libcamera::ipa::ipu3 { * \struct IPASessionConfiguration::agc * \brief AGC parameters configuration of the IPA * - * \var IPASessionConfiguration::agc::minShutterSpeed + * \var IPASessionConfiguration::minShutterSpeed * \brief Minimum shutter speed supported with the configured sensor * - * \var IPASessionConfiguration::grid::maxShutterSpeed + * \var IPASessionConfiguration::maxShutterSpeed * \brief Maximum shutter speed supported with the configured sensor * - * \var IPASessionConfiguration::grid::minAnalogueGain + * \var IPASessionConfiguration::minAnalogueGain * \brief Minimum analogue gain supported with the configured sensor * - * \var IPASessionConfiguration::grid::maxAnalogueGain + * \var IPASessionConfiguration::maxAnalogueGain * \brief Maximum analogue gain supported with the configured sensor */ @@ -93,10 +93,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. @@ -106,16 +106,16 @@ namespace libcamera::ipa::ipu3 { * \struct IPAFrameContext::awb * \brief Context for the Automatic White Balance algorithm * - * \struct IPAFrameContext::awb::gains + * \struct IPAFrameContext::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 */ @@ -123,10 +123,10 @@ namespace libcamera::ipa::ipu3 { * \struct IPAFrameContext::toneMapping * \brief Context for ToneMapping and Gamma control * - * \var IPAFrameContext::toneMapping::gamma + * \var IPAFrameContext::gamma * \brief Gamma value for the LUT * - * \var IPAFrameContext::toneMapping::gammaCorrection + * \var IPAFrameContext::gammaCorrection * \brief Per-pixel tone mapping implemented as a LUT * * The LUT structure is defined by the IPU3 kernel interface. See