Patch Detail
Show a patch.
GET /api/1.1/patches/17310/?format=api
{ "id": 17310, "url": "https://patchwork.libcamera.org/api/1.1/patches/17310/?format=api", "web_url": "https://patchwork.libcamera.org/patch/17310/", "project": { "id": 1, "url": "https://patchwork.libcamera.org/api/1.1/projects/1/?format=api", "name": "libcamera", "link_name": "libcamera", "list_id": "libcamera_core", "list_email": "libcamera-devel@lists.libcamera.org", "web_url": "", "scm_url": "", "webscm_url": "" }, "msgid": "<20220908014200.28728-2-laurent.pinchart@ideasonboard.com>", "date": "2022-09-08T01:41:29", "name": "[libcamera-devel,v4,01/32] ipa: ipu3: Fix style of Doxygen comment blocks", "commit_ref": null, "pull_url": null, "state": "superseded", "archived": false, "hash": "ce782e73eb9bd62465666d16c5f02a365348a025", "submitter": { "id": 2, "url": "https://patchwork.libcamera.org/api/1.1/people/2/?format=api", "name": "Laurent Pinchart", "email": "laurent.pinchart@ideasonboard.com" }, "delegate": null, "mbox": "https://patchwork.libcamera.org/patch/17310/mbox/", "series": [ { "id": 3476, "url": "https://patchwork.libcamera.org/api/1.1/series/3476/?format=api", "web_url": "https://patchwork.libcamera.org/project/libcamera/list/?series=3476", "date": "2022-09-08T01:41:28", "name": "ipa: Frame context queue, IPU3 & RkISP consolidation, and RkISP1 improvements", "version": 4, "mbox": "https://patchwork.libcamera.org/series/3476/mbox/" } ], "comments": "https://patchwork.libcamera.org/api/patches/17310/comments/", "check": "pending", "checks": "https://patchwork.libcamera.org/api/patches/17310/checks/", "tags": {}, "headers": { "Return-Path": "<libcamera-devel-bounces@lists.libcamera.org>", "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 7C170C327D\n\tfor <parsemail@patchwork.libcamera.org>;\n\tThu, 8 Sep 2022 01:42:21 +0000 (UTC)", "from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id 33C4062090;\n\tThu, 8 Sep 2022 03:42:21 +0200 (CEST)", "from perceval.ideasonboard.com (perceval.ideasonboard.com\n\t[213.167.242.64])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id 216706208F\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tThu, 8 Sep 2022 03:42:19 +0200 (CEST)", "from pendragon.ideasonboard.com (62-78-145-57.bb.dnainternet.fi\n\t[62.78.145.57])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id A1CE86CC\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tThu, 8 Sep 2022 03:42:18 +0200 (CEST)" ], "DKIM-Signature": [ "v=1; a=rsa-sha256; c=relaxed/simple; d=libcamera.org;\n\ts=mail; t=1662601341;\n\tbh=1H7Yhw29Av1nCbAcY+MzMe9hiOH0+OQVs1mKKAQ0hbk=;\n\th=To:Date:In-Reply-To:References:Subject:List-Id:List-Unsubscribe:\n\tList-Archive:List-Post:List-Help:List-Subscribe:From:Reply-To:\n\tFrom;\n\tb=ytK/Hy4/mppRarhMVeYH6foi6vM58E2g6wrqARZabmw2oANSeU7IgnqBiOsRdFWTQ\n\tSjmIbea8ih1nh+wQ+fKeyOEql7pm6RsyhTirF28YSDZl0mzBsTR2sfLb94VwfxhIHs\n\tPuSboK0lYX68hyd1nOIfYw06+o5rDNB64508a7yuJnu+9mMdubCCu5EdIs+Db7sdxn\n\t9RVZ2rHdjFnAU/ZQHMEKS/bPA3FsVAp+Jhc+6vV6BDUN9/n1VxgThZIshZw2KY76Uf\n\t776XEzSTczy9+bp+zCJg/FeiMiayxz8F3LWkDR+EZN7/HlvyPL62IjDeuFhw3MUssV\n\tij6HdUH+CaSbg==", "v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1662601338;\n\tbh=1H7Yhw29Av1nCbAcY+MzMe9hiOH0+OQVs1mKKAQ0hbk=;\n\th=From:To:Subject:Date:In-Reply-To:References:From;\n\tb=luTfHtcYBmnYlUTd3cqxNOio2GcduMAb/ecUEeq28L2LnRiLSmi5p7cpWITdudhMu\n\tG0u4N9NfSWcxurhn6NlHqFgrahSshWVEZbM8mj3Vxke69sJizhhcaLNG66lIgvckzk\n\t60+Ad5nWXdUYu9i4DpVEeyEm+5Utxf/TOcTWLVU8=" ], "Authentication-Results": "lancelot.ideasonboard.com; dkim=pass (1024-bit key; \n\tunprotected) header.d=ideasonboard.com\n\theader.i=@ideasonboard.com\n\theader.b=\"luTfHtcY\"; dkim-atps=neutral", "To": "libcamera-devel@lists.libcamera.org", "Date": "Thu, 8 Sep 2022 04:41:29 +0300", "Message-Id": "<20220908014200.28728-2-laurent.pinchart@ideasonboard.com>", "X-Mailer": "git-send-email 2.35.1", "In-Reply-To": "<20220908014200.28728-1-laurent.pinchart@ideasonboard.com>", "References": "<20220908014200.28728-1-laurent.pinchart@ideasonboard.com>", "MIME-Version": "1.0", "Content-Transfer-Encoding": "8bit", "Subject": "[libcamera-devel] [PATCH v4 01/32] ipa: ipu3: Fix style of Doxygen\n\tcomment blocks", "X-BeenThere": "libcamera-devel@lists.libcamera.org", "X-Mailman-Version": "2.1.29", "Precedence": "list", "List-Id": "<libcamera-devel.lists.libcamera.org>", "List-Unsubscribe": "<https://lists.libcamera.org/options/libcamera-devel>,\n\t<mailto:libcamera-devel-request@lists.libcamera.org?subject=unsubscribe>", "List-Archive": "<https://lists.libcamera.org/pipermail/libcamera-devel/>", "List-Post": "<mailto:libcamera-devel@lists.libcamera.org>", "List-Help": "<mailto:libcamera-devel-request@lists.libcamera.org?subject=help>", "List-Subscribe": "<https://lists.libcamera.org/listinfo/libcamera-devel>,\n\t<mailto:libcamera-devel-request@lists.libcamera.org?subject=subscribe>", "From": "Laurent Pinchart via libcamera-devel\n\t<libcamera-devel@lists.libcamera.org>", "Reply-To": "Laurent Pinchart <laurent.pinchart@ideasonboard.com>", "Errors-To": "libcamera-devel-bounces@lists.libcamera.org", "Sender": "\"libcamera-devel\" <libcamera-devel-bounces@lists.libcamera.org>" }, "content": "Fix various issues in Doxygen comment blocks:\n\n- \\param requires an [in] or [out] tag\n- \\param must come before the body of the documetation\n- Rename coarseSearchStep to kCoarseSearchStep\n- White space and line wrap\n\nSigned-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>\n---\n src/ipa/ipu3/algorithms/af.cpp | 23 ++++++++++-------------\n src/ipa/ipu3/algorithms/blc.cpp | 4 ++--\n src/ipa/ipu3/algorithms/tone_mapping.cpp | 10 +++++-----\n 3 files changed, 17 insertions(+), 20 deletions(-)", "diff": "diff --git a/src/ipa/ipu3/algorithms/af.cpp b/src/ipa/ipu3/algorithms/af.cpp\nindex 4835a0345931..106a7614e2c7 100644\n--- a/src/ipa/ipu3/algorithms/af.cpp\n+++ b/src/ipa/ipu3/algorithms/af.cpp\n@@ -196,10 +196,10 @@ int Af::configure(IPAContext &context, const IPAConfigInfo &configInfo)\n \n /**\n * \\brief AF coarse scan\n- *\n- * Find a near focused image using a coarse step. The step is determined by coarseSearchStep.\n- *\n * \\param[in] context The shared IPA context\n+ *\n+ * Find a near focused image using a coarse step. The step is determined by\n+ * kCoarseSearchStep.\n */\n void Af::afCoarseScan(IPAContext &context)\n {\n@@ -223,10 +223,9 @@ void Af::afCoarseScan(IPAContext &context)\n \n /**\n * \\brief AF fine scan\n+ * \\param[in] context The shared IPA context\n *\n * Find an optimum lens position with moving 1 step for each search.\n- *\n- * \\param[in] context The shared IPA context\n */\n void Af::afFineScan(IPAContext &context)\n {\n@@ -244,10 +243,9 @@ void Af::afFineScan(IPAContext &context)\n \n /**\n * \\brief AF reset\n+ * \\param[in] context The shared IPA context\n *\n * Reset all the parameters to start over the AF process.\n- *\n- * \\param[in] context The shared IPA context\n */\n void Af::afReset(IPAContext &context)\n {\n@@ -268,7 +266,7 @@ void Af::afReset(IPAContext &context)\n /**\n * \\brief AF variance comparison.\n * \\param[in] context The IPA context\n- * \\param min_step The VCM movement step.\n+ * \\param[in] min_step The VCM movement step.\n *\n * We always pick the largest variance to replace the previous one. The image\n * with a larger variance also indicates it is a clearer image than previous\n@@ -343,9 +341,8 @@ void Af::afIgnoreFrameReset()\n \n /**\n * \\brief Estimate variance\n- * \\param y_item The AF filter data set from the IPU3 statistics buffer\n- * \\param len The quantity of table item entries which are valid to process\n- * \\param isY1 Selects between filter Y1 or Y2 to calculate the variance\n+ * \\param[in] y_items The AF filter data set from the IPU3 statistics buffer\n+ * \\param[in] isY1 Selects between filter Y1 or Y2 to calculate the variance\n *\n * Calculate the mean of the data set provided by \\a y_item, and then calculate\n * the variance of that data set from the mean.\n@@ -378,13 +375,13 @@ double Af::afEstimateVariance(Span<const y_table_item_t> y_items, bool isY1)\n \n /**\n * \\brief Determine out-of-focus situation.\n- * \\param context The IPA context.\n+ * \\param[in] context The IPA context.\n *\n * Out-of-focus means that the variance change rate for a focused and a new\n * variance is greater than a threshold.\n *\n * \\return True if the variance threshold is crossed indicating lost focus,\n- * false otherwise.\n+ * false otherwise\n */\n bool Af::afIsOutOfFocus(IPAContext context)\n {\ndiff --git a/src/ipa/ipu3/algorithms/blc.cpp b/src/ipa/ipu3/algorithms/blc.cpp\nindex c561aa858b96..c32427c99549 100644\n--- a/src/ipa/ipu3/algorithms/blc.cpp\n+++ b/src/ipa/ipu3/algorithms/blc.cpp\n@@ -38,8 +38,8 @@ BlackLevelCorrection::BlackLevelCorrection()\n \n /**\n * \\brief Fill in the parameter structure, and enable black level correction\n- * \\param context The shared IPA context\n- * \\param params The IPU3 parameters\n+ * \\param[in] context The shared IPA context\n+ * \\param[out] params The IPU3 parameters\n *\n * Populate the IPU3 parameter structure with the correction values for each\n * channel and enable the corresponding ImgU block processing.\ndiff --git a/src/ipa/ipu3/algorithms/tone_mapping.cpp b/src/ipa/ipu3/algorithms/tone_mapping.cpp\nindex 49a5558b6faa..c21647e8c51b 100644\n--- a/src/ipa/ipu3/algorithms/tone_mapping.cpp\n+++ b/src/ipa/ipu3/algorithms/tone_mapping.cpp\n@@ -49,8 +49,8 @@ int ToneMapping::configure(IPAContext &context,\n \n /**\n * \\brief Fill in the parameter structure, and enable gamma control\n- * \\param context The shared IPA context\n- * \\param params The IPU3 parameters\n+ * \\param[in] context The shared IPA context\n+ * \\param[out] params The IPU3 parameters\n *\n * Populate the IPU3 parameter structure with our tone mapping look up table and\n * enable the gamma control module in the processing blocks.\n@@ -71,9 +71,9 @@ void ToneMapping::prepare([[maybe_unused]] IPAContext &context,\n \n /**\n * \\brief Calculate the tone mapping look up table\n- * \\param context The shared IPA context\n- * \\param frameContext The current frame context\n- * \\param stats The IPU3 statistics and ISP results\n+ * \\param[in] context The shared IPA context\n+ * \\param[in] frameContext The current frame context\n+ * \\param[in] stats The IPU3 statistics and ISP results\n *\n * The tone mapping look up table is generated as an inverse power curve from\n * our gamma setting.\n", "prefixes": [ "libcamera-devel", "v4", "01/32" ] }