{"id":20277,"url":"https://patchwork.libcamera.org/api/patches/20277/?format=json","web_url":"https://patchwork.libcamera.org/patch/20277/","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":"<20240613013944.23344-6-laurent.pinchart@ideasonboard.com>","date":"2024-06-13T01:39:38","name":"[05/11] ipa: libipa: pwl: Suffix \\param with direction","commit_ref":null,"pull_url":null,"state":"accepted","archived":false,"hash":"1f70a7ada72372bd946f03d863fe85c777df3375","submitter":{"id":2,"url":"https://patchwork.libcamera.org/api/people/2/?format=json","name":"Laurent Pinchart","email":"laurent.pinchart@ideasonboard.com"},"delegate":null,"mbox":"https://patchwork.libcamera.org/patch/20277/mbox/","series":[{"id":4386,"url":"https://patchwork.libcamera.org/api/series/4386/?format=json","web_url":"https://patchwork.libcamera.org/project/libcamera/list/?series=4386","date":"2024-06-13T01:39:33","name":"ipa: libipa: Vector and Pwl improvements","version":1,"mbox":"https://patchwork.libcamera.org/series/4386/mbox/"}],"comments":"https://patchwork.libcamera.org/api/patches/20277/comments/","check":"pending","checks":"https://patchwork.libcamera.org/api/patches/20277/checks/","tags":{},"headers":{"Return-Path":"","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 194F0C32CF\n\tfor ;\n\tThu, 13 Jun 2024 01:40:18 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id A3B846549D;\n\tThu, 13 Jun 2024 03:40:17 +0200 (CEST)","from perceval.ideasonboard.com (perceval.ideasonboard.com\n\t[213.167.242.64])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id 9AF426548C\n\tfor ;\n\tThu, 13 Jun 2024 03:40:11 +0200 (CEST)","from pendragon.ideasonboard.com (81-175-209-231.bb.dnainternet.fi\n\t[81.175.209.231])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id CBD9BE39;\n\tThu, 13 Jun 2024 03:39:57 +0200 (CEST)"],"Authentication-Results":"lancelot.ideasonboard.com; dkim=pass (1024-bit key;\n\tunprotected) header.d=ideasonboard.com header.i=@ideasonboard.com\n\theader.b=\"Qzdcl1Gi\"; dkim-atps=neutral","DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1718242798;\n\tbh=R24D/tLrCwiSeu16WgLpUhETYKZRuAaY2OYR7W3QM7Q=;\n\th=From:To:Cc:Subject:Date:In-Reply-To:References:From;\n\tb=Qzdcl1GiJ6Jt1t1wx9kI+iHVXx2rwgRL9Colmma9gSxHUX3W5cmNSB5Llhy/Nyd1q\n\teHrsVvJ0NrONh4sQNlsKn7qBJVWF5qIUS6waZG507ngfGcQbQbKs6WMLRCS0y50X+U\n\tfUvCmFfV8sbYpp2vys+jZFkfZgrCzlOGsqyRNB3E=","From":"Laurent Pinchart ","To":"libcamera-devel@lists.libcamera.org","Cc":"Paul Elder ,\n\tDavid Plowman ,\n\tNaushir 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","Content-Transfer-Encoding":"8bit","X-BeenThere":"libcamera-devel@lists.libcamera.org","X-Mailman-Version":"2.1.29","Precedence":"list","List-Id":"","List-Unsubscribe":",\n\t","List-Archive":"","List-Post":"","List-Help":"","List-Subscribe":",\n\t","Errors-To":"libcamera-devel-bounces@lists.libcamera.org","Sender":"\"libcamera-devel\" "},"content":"Suffix the Doxygen \\param commands with the direction for all\nparameters.\n\nSigned-off-by: Laurent Pinchart \n---\n src/ipa/libipa/pwl.cpp | 41 +++++++++++++++++++++--------------------\n 1 file changed, 21 insertions(+), 20 deletions(-)","diff":"diff --git a/src/ipa/libipa/pwl.cpp b/src/ipa/libipa/pwl.cpp\nindex 901e42ceb2ce..1ba0108515a1 100644\n--- a/src/ipa/libipa/pwl.cpp\n+++ b/src/ipa/libipa/pwl.cpp\n@@ -60,14 +60,14 @@ namespace ipa {\n /**\n * \\fn Pwl::Interval::Interval(double _start, double _end)\n * \\brief Construct an interval\n- * \\param _start Start of the interval\n- * \\param _end End of the interval\n+ * \\param[in] _start Start of the interval\n+ * \\param[in] _end End of the interval\n */\n \n /**\n * \\fn Pwl::Interval::contains\n * \\brief Check if a given value falls within the interval\n- * \\param value Value to check\n+ * \\param[in] value Value to check\n * \\return True if the value falls within the interval, including its bounds,\n * or false otherwise\n */\n@@ -75,7 +75,7 @@ namespace ipa {\n /**\n * \\fn Pwl::Interval::clamp\n * \\brief Clamp a value such that it is within the interval\n- * \\param value Value to clamp\n+ * \\param[in] value Value to clamp\n * \\return The clamped value\n */\n \n@@ -104,7 +104,8 @@ Pwl::Pwl()\n \n /**\n * \\brief Construct a piecewise linear function from a list of 2D points\n- * \\param points Vector of points from which to construct the piecewise linear function\n+ * \\param[in] points Vector of points from which to construct the piecewise\n+ * linear function\n *\n * \\a points must be in ascending order of x-value.\n */\n@@ -115,7 +116,7 @@ Pwl::Pwl(const std::vector &points)\n \n /**\n * \\brief Populate the piecewise linear function from yaml data\n- * \\param params Yaml data to populate the piecewise linear function with\n+ * \\param[in] params Yaml data to populate the piecewise linear function with\n *\n * Any existing points in the piecewise linear function *will* be overwritten.\n *\n@@ -153,9 +154,9 @@ int Pwl::readYaml(const libcamera::YamlObject ¶ms)\n \n /**\n * \\brief Append a point to the end of the piecewise linear function\n- * \\param x x-coordinate of the point to add to the piecewise linear function\n- * \\param y y-coordinate of the point to add to the piecewise linear function\n- * \\param eps Epsilon for the minimum x distance between points (optional)\n+ * \\param[in] x x-coordinate of the point to add to the piecewise linear function\n+ * \\param[in] y y-coordinate of the point to add to the piecewise linear function\n+ * \\param[in] eps Epsilon for the minimum x distance between points (optional)\n *\n * The point's x-coordinate must be greater than the x-coordinate of the last\n * (= greatest) point already in the piecewise linear function.\n@@ -168,9 +169,9 @@ void Pwl::append(double x, double y, const double eps)\n \n /**\n * \\brief Prepend a point to the beginning of the piecewise linear function\n- * \\param x x-coordinate of the point to add to the piecewise linear function\n- * \\param y y-coordinate of the point to add to the piecewise linear function\n- * \\param eps Epsilon for the minimum x distance between points (optional)\n+ * \\param[in] x x-coordinate of the point to add to the piecewise linear function\n+ * \\param[in] y y-coordinate of the point to add to the piecewise linear function\n+ * \\param[in] eps Epsilon for the minimum x distance between points (optional)\n *\n * The point's x-coordinate must be less than the x-coordinate of the first\n * (= smallest) point already in the piecewise linear function.\n@@ -353,7 +354,7 @@ Pwl Pwl::compose(Pwl const &other, const double eps) const\n \n /**\n * \\brief Apply function to (x, y) values at every control point\n- * \\param f Function to be applied\n+ * \\param[in] f Function to be applied\n */\n void Pwl::map(std::function f) const\n {\n@@ -364,9 +365,9 @@ void Pwl::map(std::function f) const\n /**\n * \\brief Apply function to (x, y0, y1) values wherever either Pwl has a\n * control point.\n- * \\param pwl0 First piecewise linear function\n- * \\param pwl1 Second piecewise linear function\n- * \\param f Function to be applied\n+ * \\param[in] pwl0 First piecewise linear function\n+ * \\param[in] pwl1 Second piecewise linear function\n+ * \\param[in] f Function to be applied\n *\n * This applies the function \\a f to every parameter (x, y0, y1), where x is\n * the combined list of x-values from \\a pwl0 and \\a pwl1, y0 is the y-value\n@@ -395,9 +396,9 @@ void Pwl::map2(Pwl const &pwl0, Pwl const &pwl1,\n \n /**\n * \\brief Combine two Pwls\n- * \\param pwl0 First piecewise linear function\n- * \\param pwl1 Second piecewise linear function\n- * \\param f Function to be applied\n+ * \\param[in] pwl0 First piecewise linear function\n+ * \\param[in] pwl1 Second piecewise linear function\n+ * \\param[in] f Function to be applied\n * \\param[in] eps Epsilon for the minimum x distance between points (optional)\n *\n * Create a new Pwl where the y values are given by running \\a f wherever\n@@ -418,7 +419,7 @@ Pwl Pwl::combine(Pwl const &pwl0, Pwl const &pwl1,\n \n /**\n * \\brief Multiply the piecewise linear function\n- * \\param d Scalar multiplier to multiply the function by\n+ * \\param[in] d Scalar multiplier to multiply the function by\n * \\return This function, after it has been multiplied by \\a d\n */\n Pwl &Pwl::operator*=(double d)\n","prefixes":["05/11"]}