From 467bd6268d610c109827b874aa2e3a61744f6d49 Mon Sep 17 00:00:00 2001 From: Laurent Pinchart Date: Mon, 13 May 2024 15:04:45 +0300 Subject: ipa: libipa: histogram: Fix documentation of constructor 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 missed 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(+) (limited to 'src') diff --git a/src/ipa/libipa/histogram.cpp b/src/ipa/libipa/histogram.cpp index 633dbd05..5fbfadf5 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 -- cgit v1.2.1