{"id":20043,"url":"https://patchwork.libcamera.org/api/patches/20043/?format=json","web_url":"https://patchwork.libcamera.org/patch/20043/","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":"<20240513121645.2891-1-laurent.pinchart@ideasonboard.com>","date":"2024-05-13T12:16:45","name":"ipa: libipa: histogram: Fix documentation of constructor","commit_ref":"467bd6268d610c109827b874aa2e3a61744f6d49","pull_url":null,"state":"accepted","archived":false,"hash":"70f67de8a14ef51302f9e660a902984c8e662eda","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/20043/mbox/","series":[{"id":4306,"url":"https://patchwork.libcamera.org/api/series/4306/?format=json","web_url":"https://patchwork.libcamera.org/project/libcamera/list/?series=4306","date":"2024-05-13T12:16:45","name":"ipa: libipa: histogram: Fix documentation of constructor","version":1,"mbox":"https://patchwork.libcamera.org/series/4306/mbox/"}],"comments":"https://patchwork.libcamera.org/api/patches/20043/comments/","check":"pending","checks":"https://patchwork.libcamera.org/api/patches/20043/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 7D4A6BDE6B\n\tfor <parsemail@patchwork.libcamera.org>;\n\tMon, 13 May 2024 12:16:55 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id B03B36346B;\n\tMon, 13 May 2024 14:16:54 +0200 (CEST)","from perceval.ideasonboard.com (perceval.ideasonboard.com\n\t[IPv6:2001:4b98:dc2:55:216:3eff:fef7:d647])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id 5ECB061A5E\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tMon, 13 May 2024 14:16:53 +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 DB80CCC8\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tMon, 13 May 2024 14:16:46 +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=\"FSiUB+8O\"; dkim-atps=neutral","DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1715602607;\n\tbh=t02gEvdTnuxGPGjFzcGGyrZaa1ZqEYX3f4iJIqGK6x0=;\n\th=From:To:Subject:Date:From;\n\tb=FSiUB+8O1DXBeaO7hpjft/CpYZuWXZEYuVpbZaKftlEsJw4MO+pW1StLMHlBUbdxl\n\tC7sAp92iRNgPys4/tNRSqKh70i8VUduhI+c5g6COwtOO5O99aQK9Y0t3KQQKT0NGPk\n\t7NUUQdC7mfUojOkCHfaMzfl7ecdRmyxVQDMVIp/g=","From":"Laurent Pinchart <laurent.pinchart@ideasonboard.com>","To":"libcamera-devel@lists.libcamera.org","Subject":"[PATCH] ipa: libipa: histogram: Fix documentation of constructor","Date":"Mon, 13 May 2024 15:16:45 +0300","Message-ID":"<20240513121645.2891-1-laurent.pinchart@ideasonboard.com>","X-Mailer":"git-send-email 2.43.2","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":"<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>","Errors-To":"libcamera-devel-bounces@lists.libcamera.org","Sender":"\"libcamera-devel\" <libcamera-devel-bounces@lists.libcamera.org>"},"content":"Commit 1dc01bc9e6c3 (\"ipa: libipa: histogram: Add transform parameter to\nconstructor\") added a new constructor for the Histogram class. The\nimplementation is inline in the header file, and the documentation was\nadded in the corresponding .cpp file, but it messed the \\fn directive.\nThis causes Doxygen to complain:\n\nsrc/ipa/libipa/histogram.h:31: warning: Member Histogram(Span< const uint32_t > data, Transform transform) (function) of class libcamera::ipa::Histogram is not documented.\nsrc/ipa/libipa/histogram.cpp:59: warning: libcamera::ipa::Histogram::bins has @param documentation sections but no arguments\n\nFix it.\n\nFixes: 1dc01bc9e6c3 (\"ipa: libipa: histogram: Add transform parameter to constructor\")\nSigned-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>\n---\n src/ipa/libipa/histogram.cpp | 1 +\n 1 file changed, 1 insertion(+)\n\n\nbase-commit: 3cb20bc2301c03d01a631eb637ab47031d2b91e6","diff":"diff --git a/src/ipa/libipa/histogram.cpp b/src/ipa/libipa/histogram.cpp\nindex 633dbd052c1c..5fbfadf5e4e1 100644\n--- a/src/ipa/libipa/histogram.cpp\n+++ b/src/ipa/libipa/histogram.cpp\n@@ -50,6 +50,7 @@ Histogram::Histogram(Span<const uint32_t> data)\n }\n \n /**\n+ * \\fn Histogram::Histogram(Span<const uint32_t> data, Transform transform)\n  * \\brief Create a cumulative histogram\n  * \\param[in] data A (non-cumulative) histogram\n  * \\param[in] transform The transformation function to apply to every bin\n","prefixes":[]}