From patchwork Mon May 13 12:16:45 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Laurent Pinchart X-Patchwork-Id: 20043 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 7D4A6BDE6B for ; Mon, 13 May 2024 12:16:55 +0000 (UTC) Received: from lancelot.ideasonboard.com (localhost [IPv6:::1]) by lancelot.ideasonboard.com (Postfix) with ESMTP id B03B36346B; Mon, 13 May 2024 14:16:54 +0200 (CEST) Authentication-Results: lancelot.ideasonboard.com; dkim=pass (1024-bit key; unprotected) header.d=ideasonboard.com header.i=@ideasonboard.com header.b="FSiUB+8O"; dkim-atps=neutral Received: from perceval.ideasonboard.com (perceval.ideasonboard.com [IPv6:2001:4b98:dc2:55:216:3eff:fef7:d647]) by lancelot.ideasonboard.com (Postfix) with ESMTPS id 5ECB061A5E for ; Mon, 13 May 2024 14:16:53 +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 DB80CCC8 for ; Mon, 13 May 2024 14:16:46 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com; s=mail; t=1715602607; bh=t02gEvdTnuxGPGjFzcGGyrZaa1ZqEYX3f4iJIqGK6x0=; h=From:To:Subject:Date:From; b=FSiUB+8O1DXBeaO7hpjft/CpYZuWXZEYuVpbZaKftlEsJw4MO+pW1StLMHlBUbdxl C7sAp92iRNgPys4/tNRSqKh70i8VUduhI+c5g6COwtOO5O99aQK9Y0t3KQQKT0NGPk 7NUUQdC7mfUojOkCHfaMzfl7ecdRmyxVQDMVIp/g= From: Laurent Pinchart 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 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" Commit 1dc01bc9e6c3 ("ipa: libipa: histogram: Add transform parameter to constructor") added a new constructor for the Histogram class. The implementation is inline in the header file, and the documentation was added in the corresponding .cpp file, but it messed the \fn directive. This causes Doxygen to complain: src/ipa/libipa/histogram.h:31: warning: Member Histogram(Span< const uint32_t > data, Transform transform) (function) of class libcamera::ipa::Histogram is not documented. src/ipa/libipa/histogram.cpp:59: warning: libcamera::ipa::Histogram::bins has @param documentation sections but no arguments Fix it. Fixes: 1dc01bc9e6c3 ("ipa: libipa: histogram: Add transform parameter to constructor") Signed-off-by: Laurent Pinchart Reviewed-by: Umang Jain Reviewed-by: Stefan Klug --- src/ipa/libipa/histogram.cpp | 1 + 1 file changed, 1 insertion(+) base-commit: 3cb20bc2301c03d01a631eb637ab47031d2b91e6 diff --git a/src/ipa/libipa/histogram.cpp b/src/ipa/libipa/histogram.cpp index 633dbd052c1c..5fbfadf5e4e1 100644 --- a/src/ipa/libipa/histogram.cpp +++ b/src/ipa/libipa/histogram.cpp @@ -50,6 +50,7 @@ Histogram::Histogram(Span data) } /** + * \fn Histogram::Histogram(Span data, Transform transform) * \brief Create a cumulative histogram * \param[in] data A (non-cumulative) histogram * \param[in] transform The transformation function to apply to every bin