ipa: libipa: histogram: Fix documentation of constructor

20043 diff mbox series

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 <laurent.pinchart@ideasonboard.com>
---
 src/ipa/libipa/histogram.cpp | 1 +
 1 file changed, 1 insertion(+)


base-commit: 3cb20bc2301c03d01a631eb637ab47031d2b91e6

Hi Laurent,

Thank you for the fix.

On 13/05/24 5:46 pm, Laurent Pinchart wrote:
> 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 <laurent.pinchart@ideasonboard.com>

Reviewed-by: Umang Jain <umang.jain@ideasonboard.com>
> ---
>   src/ipa/libipa/histogram.cpp | 1 +
>   1 file changed, 1 insertion(+)
>
> 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<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
>
> base-commit: 3cb20bc2301c03d01a631eb637ab47031d2b91e6

Hi Laurent,

thanks for the patch.

On Mon, May 13, 2024 at 03:16:45PM +0300, Laurent Pinchart wrote:
> 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.

nit: s/messed/missed/

> 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: Stefan Klug <stefan.klug@ideasonboard.com> 

Cheers,
Stefan

> ---
>  src/ipa/libipa/histogram.cpp | 1 +
>  1 file changed, 1 insertion(+)
> 
> 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<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
> 
> base-commit: 3cb20bc2301c03d01a631eb637ab47031d2b91e6
> -- 
> Regards,
> 
> Laurent Pinchart
>