summaryrefslogtreecommitdiff
path: root/src/ipa
diff options
context:
space:
mode:
authorLaurent Pinchart <laurent.pinchart@ideasonboard.com>2024-05-13 15:04:45 +0300
committerLaurent Pinchart <laurent.pinchart@ideasonboard.com>2024-05-13 16:33:43 +0300
commit467bd6268d610c109827b874aa2e3a61744f6d49 (patch)
treeb2e4afa916d57f83fe8c1f7723f6076365b3256d /src/ipa
parent3cb20bc2301c03d01a631eb637ab47031d2b91e6 (diff)
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 <laurent.pinchart@ideasonboard.com> Reviewed-by: Umang Jain <umang.jain@ideasonboard.com> Reviewed-by: Stefan Klug <stefan.klug@ideasonboard.com>
Diffstat (limited to 'src/ipa')
-rw-r--r--src/ipa/libipa/histogram.cpp1
1 files changed, 1 insertions, 0 deletions
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<const uint32_t> data)
}
/**
+ * \fn Histogram::Histogram(Span<const uint32_t> 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