[libcamera-devel] [PATCH] ipa: ipu3: Fix minor Doxygen issues in IPAFrameContext

[Laurent Pinchart]

On Tue, May 17, 2022 at 05:18:40PM +0300, Laurent Pinchart via libcamera-devel wrote:
> The IPAFrameContext documentation has a spurious Doxygen \struct
> statement that is not needed, and uses a \struct instead of a \var in
> another location. Fix both issues. This doesn't cause any change in the
> generated documentation.

Note that the Doxygen output for IPAFrameContext is incorrect,
documentation is missing for all members. This is caused by using "."
instead of "::" in our documentation, which we currently do because the
correct syntax produces Doxygen warnings (and still incorrect output).
See https://github.com/doxygen/doxygen/issues/9343.

> Signed-off-by: Laurent Pinchart <laurent.pinchart at ideasonboard.com>
> ---
>  src/ipa/ipu3/ipa_context.cpp | 3 +--
>  1 file changed, 1 insertion(+), 2 deletions(-)
> 
> diff --git a/src/ipa/ipu3/ipa_context.cpp b/src/ipa/ipu3/ipa_context.cpp
> index b1570dde7fe4..26e74c747877 100644
> --- a/src/ipa/ipu3/ipa_context.cpp
> +++ b/src/ipa/ipu3/ipa_context.cpp
> @@ -81,7 +81,6 @@ namespace libcamera::ipa::ipu3 {
>   * \var IPAFrameContext::af
>   * \brief Context for the Automatic Focus algorithm
>   *
> - * \struct  IPAFrameContext::af
>   * \var IPAFrameContext::af.focus
>   * \brief Current position of the lens
>   *
> @@ -140,7 +139,7 @@ namespace libcamera::ipa::ipu3 {
>   * \var IPAFrameContext::awb
>   * \brief Context for the Automatic White Balance algorithm
>   *
> - * \struct IPAFrameContext::awb.gains
> + * \var IPAFrameContext::awb.gains
>   * \brief White balance gains
>   *
>   * \var IPAFrameContext::awb.gains.red
> 
> base-commit: 5efb6c8e2acdc2dc9edf1f22f6c2a5818062b69e

-- 
Regards,

Laurent Pinchart