From patchwork Thu Jun 13 01:39:38 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Laurent Pinchart X-Patchwork-Id: 20277 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 194F0C32CF for ; Thu, 13 Jun 2024 01:40:18 +0000 (UTC) Received: from lancelot.ideasonboard.com (localhost [IPv6:::1]) by lancelot.ideasonboard.com (Postfix) with ESMTP id A3B846549D; Thu, 13 Jun 2024 03:40:17 +0200 (CEST) Authentication-Results: lancelot.ideasonboard.com; dkim=pass (1024-bit key; unprotected) header.d=ideasonboard.com header.i=@ideasonboard.com header.b="Qzdcl1Gi"; dkim-atps=neutral Received: from perceval.ideasonboard.com (perceval.ideasonboard.com [213.167.242.64]) by lancelot.ideasonboard.com (Postfix) with ESMTPS id 9AF426548C for ; Thu, 13 Jun 2024 03:40:11 +0200 (CEST) Received: from pendragon.ideasonboard.com (81-175-209-231.bb.dnainternet.fi [81.175.209.231]) by perceval.ideasonboard.com (Postfix) with ESMTPSA id CBD9BE39; Thu, 13 Jun 2024 03:39:57 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com; s=mail; t=1718242798; bh=R24D/tLrCwiSeu16WgLpUhETYKZRuAaY2OYR7W3QM7Q=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=Qzdcl1GiJ6Jt1t1wx9kI+iHVXx2rwgRL9Colmma9gSxHUX3W5cmNSB5Llhy/Nyd1q eHrsVvJ0NrONh4sQNlsKn7qBJVWF5qIUS6waZG507ngfGcQbQbKs6WMLRCS0y50X+U fUvCmFfV8sbYpp2vys+jZFkfZgrCzlOGsqyRNB3E= From: Laurent Pinchart To: libcamera-devel@lists.libcamera.org Cc: Paul Elder , David Plowman , Naushir Patuck Subject: [PATCH 05/11] ipa: libipa: pwl: Suffix \param with direction Date: Thu, 13 Jun 2024 04:39:38 +0300 Message-ID: <20240613013944.23344-6-laurent.pinchart@ideasonboard.com> X-Mailer: git-send-email 2.44.2 In-Reply-To: <20240613013944.23344-1-laurent.pinchart@ideasonboard.com> References: <20240613013944.23344-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" Suffix the Doxygen \param commands with the direction for all parameters. Signed-off-by: Laurent Pinchart Reviewed-by: Paul Elder Reviewed-by: Kieran Bingham --- src/ipa/libipa/pwl.cpp | 41 +++++++++++++++++++++-------------------- 1 file changed, 21 insertions(+), 20 deletions(-) diff --git a/src/ipa/libipa/pwl.cpp b/src/ipa/libipa/pwl.cpp index 901e42ceb2ce..1ba0108515a1 100644 --- a/src/ipa/libipa/pwl.cpp +++ b/src/ipa/libipa/pwl.cpp @@ -60,14 +60,14 @@ namespace ipa { /** * \fn Pwl::Interval::Interval(double _start, double _end) * \brief Construct an interval - * \param _start Start of the interval - * \param _end End of the interval + * \param[in] _start Start of the interval + * \param[in] _end End of the interval */ /** * \fn Pwl::Interval::contains * \brief Check if a given value falls within the interval - * \param value Value to check + * \param[in] value Value to check * \return True if the value falls within the interval, including its bounds, * or false otherwise */ @@ -75,7 +75,7 @@ namespace ipa { /** * \fn Pwl::Interval::clamp * \brief Clamp a value such that it is within the interval - * \param value Value to clamp + * \param[in] value Value to clamp * \return The clamped value */ @@ -104,7 +104,8 @@ Pwl::Pwl() /** * \brief Construct a piecewise linear function from a list of 2D points - * \param points Vector of points from which to construct the piecewise linear function + * \param[in] points Vector of points from which to construct the piecewise + * linear function * * \a points must be in ascending order of x-value. */ @@ -115,7 +116,7 @@ Pwl::Pwl(const std::vector &points) /** * \brief Populate the piecewise linear function from yaml data - * \param params Yaml data to populate the piecewise linear function with + * \param[in] params Yaml data to populate the piecewise linear function with * * Any existing points in the piecewise linear function *will* be overwritten. * @@ -153,9 +154,9 @@ int Pwl::readYaml(const libcamera::YamlObject ¶ms) /** * \brief Append a point to the end of the piecewise linear function - * \param x x-coordinate of the point to add to the piecewise linear function - * \param y y-coordinate of the point to add to the piecewise linear function - * \param eps Epsilon for the minimum x distance between points (optional) + * \param[in] x x-coordinate of the point to add to the piecewise linear function + * \param[in] y y-coordinate of the point to add to the piecewise linear function + * \param[in] eps Epsilon for the minimum x distance between points (optional) * * The point's x-coordinate must be greater than the x-coordinate of the last * (= greatest) point already in the piecewise linear function. @@ -168,9 +169,9 @@ void Pwl::append(double x, double y, const double eps) /** * \brief Prepend a point to the beginning of the piecewise linear function - * \param x x-coordinate of the point to add to the piecewise linear function - * \param y y-coordinate of the point to add to the piecewise linear function - * \param eps Epsilon for the minimum x distance between points (optional) + * \param[in] x x-coordinate of the point to add to the piecewise linear function + * \param[in] y y-coordinate of the point to add to the piecewise linear function + * \param[in] eps Epsilon for the minimum x distance between points (optional) * * The point's x-coordinate must be less than the x-coordinate of the first * (= smallest) point already in the piecewise linear function. @@ -353,7 +354,7 @@ Pwl Pwl::compose(Pwl const &other, const double eps) const /** * \brief Apply function to (x, y) values at every control point - * \param f Function to be applied + * \param[in] f Function to be applied */ void Pwl::map(std::function f) const { @@ -364,9 +365,9 @@ void Pwl::map(std::function f) const /** * \brief Apply function to (x, y0, y1) values wherever either Pwl has a * control point. - * \param pwl0 First piecewise linear function - * \param pwl1 Second piecewise linear function - * \param f Function to be applied + * \param[in] pwl0 First piecewise linear function + * \param[in] pwl1 Second piecewise linear function + * \param[in] f Function to be applied * * This applies the function \a f to every parameter (x, y0, y1), where x is * the combined list of x-values from \a pwl0 and \a pwl1, y0 is the y-value @@ -395,9 +396,9 @@ void Pwl::map2(Pwl const &pwl0, Pwl const &pwl1, /** * \brief Combine two Pwls - * \param pwl0 First piecewise linear function - * \param pwl1 Second piecewise linear function - * \param f Function to be applied + * \param[in] pwl0 First piecewise linear function + * \param[in] pwl1 Second piecewise linear function + * \param[in] f Function to be applied * \param[in] eps Epsilon for the minimum x distance between points (optional) * * Create a new Pwl where the y values are given by running \a f wherever @@ -418,7 +419,7 @@ Pwl Pwl::combine(Pwl const &pwl0, Pwl const &pwl1, /** * \brief Multiply the piecewise linear function - * \param d Scalar multiplier to multiply the function by + * \param[in] d Scalar multiplier to multiply the function by * \return This function, after it has been multiplied by \a d */ Pwl &Pwl::operator*=(double d)