From patchwork Sun Feb 23 23:03:51 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Laurent Pinchart X-Patchwork-Id: 22825 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 4CA78BDB13 for ; Sun, 23 Feb 2025 23:04:35 +0000 (UTC) Received: from lancelot.ideasonboard.com (localhost [IPv6:::1]) by lancelot.ideasonboard.com (Postfix) with ESMTP id BEA07686B9; Mon, 24 Feb 2025 00:04:30 +0100 (CET) Authentication-Results: lancelot.ideasonboard.com; dkim=pass (1024-bit key; unprotected) header.d=ideasonboard.com header.i=@ideasonboard.com header.b="H1tw1Snx"; dkim-atps=neutral Received: from perceval.ideasonboard.com (perceval.ideasonboard.com [213.167.242.64]) by lancelot.ideasonboard.com (Postfix) with ESMTPS id C58EA686B9 for ; Mon, 24 Feb 2025 00:04:24 +0100 (CET) Received: from pendragon.ideasonboard.com (81-175-209-231.bb.dnainternet.fi [81.175.209.231]) by perceval.ideasonboard.com (Postfix) with ESMTPSA id 58C90353 for ; Mon, 24 Feb 2025 00:02:58 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com; s=mail; t=1740351778; bh=ueXtDkxH7HYe4b1so1xCO61Lf/G9waDNNVrKdvXPUvs=; h=From:To:Subject:Date:In-Reply-To:References:From; b=H1tw1SnxSrkP3H74H6CdXcyLwXbsujjcEJoAyUwqGWNQZMdKzfcHMCPoHFqYL1nS6 ugvDeW/mUdtkBSYICcwes2X+98m8dW1dqJg0DExmOfWgIO2fYhquloWirgYl9Y2/HA yVrC3R9kpDYJzsQkpmNgpUlp4Qk/NJ+ShlS2jsp8= From: Laurent Pinchart To: libcamera-devel@lists.libcamera.org Subject: [PATCH 03/15] libipa: awb: Follow function names with '()' in doxygen documentation Date: Mon, 24 Feb 2025 01:03:51 +0200 Message-ID: <20250223230403.1226-4-laurent.pinchart@ideasonboard.com> X-Mailer: git-send-email 2.45.3 In-Reply-To: <20250223230403.1226-1-laurent.pinchart@ideasonboard.com> References: <20250223230403.1226-1-laurent.pinchart@ideasonboard.com> MIME-Version: 1.0 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" Function names are followed by parentheses in doxygen documentation blocks as convention in libcamera. Add missing parentheses in the AwbAlgorithm documentation. Signed-off-by: Laurent Pinchart Reviewed-by: Stefan Klug --- src/ipa/libipa/awb.cpp | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/src/ipa/libipa/awb.cpp b/src/ipa/libipa/awb.cpp index dc672f129c4a..1adefa5bb929 100644 --- a/src/ipa/libipa/awb.cpp +++ b/src/ipa/libipa/awb.cpp @@ -49,7 +49,7 @@ namespace ipa { */ /** - * \fn AwbStats::computeColourError + * \fn AwbStats::computeColourError() * \brief Compute an error value for when the given gains would be applied * \param[in] gains The gains to apply * @@ -65,7 +65,7 @@ namespace ipa { */ /** - * \fn AwbStats::getRGBMeans + * \fn AwbStats::getRGBMeans() * \brief Get RGB means of the statistics * * Fetch the RGB means from the statistics. The values of each channel are @@ -85,7 +85,7 @@ namespace ipa { */ /** - * \fn AwbAlgorithm::init + * \fn AwbAlgorithm::init() * \brief Initialize the algorithm with the given tuning data * \param[in] tuningData The tuning data to use for the algorithm * @@ -93,7 +93,7 @@ namespace ipa { */ /** - * \fn AwbAlgorithm::calculateAwb + * \fn AwbAlgorithm::calculateAwb() * \brief Calculate AWB data from the given statistics * \param[in] stats The statistics to use for the calculation * \param[in] lux The lux value of the scene @@ -106,7 +106,7 @@ namespace ipa { */ /** - * \fn AwbAlgorithm::gainsFromColourTemperature + * \fn AwbAlgorithm::gainsFromColourTemperature() * \brief Compute white balance gains from a colour temperature * \param[in] colourTemperature The colour temperature in Kelvin * @@ -118,14 +118,14 @@ namespace ipa { */ /** - * \fn AwbAlgorithm::controls + * \fn AwbAlgorithm::controls() * \brief Get the controls info map for this algorithm * * \return The controls info map */ /** - * \fn AwbAlgorithm::handleControls + * \fn AwbAlgorithm::handleControls() * \param[in] controls The controls to handle * \brief Handle the controls supplied in a request */