[libcamera-devel] [PATCH v2 2/2] libcamera: class: Drop 'klass' argument from documentation

[Laurent Pinchart]

Hi Jacopo,

Thank you for the patch.

On Tue, Apr 20, 2021 at 11:38:59AM +0200, Jacopo Mondi wrote:
> The LIBCAMERA_D_PTR() and LIBCAMERA_O_PTR() macros do not require an
> argument, but the version of the macro consumed by Doxygen does.

Oops, indeed.

> Fix this by removing the klass parameter from both macros in their
> documentation version.
> 
> Signed-off-by: Jacopo Mondi <jacopo at jmondi.org>

Reviewed-by: Laurent Pinchart <laurent.pinchart at ideasonboard.com>

> ---
>  include/libcamera/class.h | 4 ++--
>  src/libcamera/class.cpp   | 6 ++----
>  2 files changed, 4 insertions(+), 6 deletions(-)
> 
> diff --git a/include/libcamera/class.h b/include/libcamera/class.h
> index 466114ecfaf4..f384a4889588 100644
> --- a/include/libcamera/class.h
> +++ b/include/libcamera/class.h
> @@ -48,8 +48,8 @@ public:									\
>  #else
>  #define LIBCAMERA_DECLARE_PRIVATE()
>  #define LIBCAMERA_DECLARE_PUBLIC(klass)
> -#define LIBCAMERA_D_PTR(klass)
> -#define LIBCAMERA_O_PTR(klass)
> +#define LIBCAMERA_D_PTR()
> +#define LIBCAMERA_O_PTR()
>  #endif
>  
>  class Extensible
> diff --git a/src/libcamera/class.cpp b/src/libcamera/class.cpp
> index 171f7c0a927b..28c35633d7db 100644
> --- a/src/libcamera/class.cpp
> +++ b/src/libcamera/class.cpp
> @@ -95,9 +95,8 @@ namespace libcamera {
>   */
>  
>  /**
> - * \def LIBCAMERA_D_PTR(klass)
> + * \def LIBCAMERA_D_PTR()
>   * \brief Retrieve the private data pointer
> - * \param[in] klass The public class name
>   *
>   * This macro can be used in any member function of a class that inherits,
>   * directly or indirectly, from the Extensible class, to create a local
> @@ -105,9 +104,8 @@ namespace libcamera {
>   */
>  
>  /**
> - * \def LIBCAMERA_O_PTR(klass)
> + * \def LIBCAMERA_O_PTR()
>   * \brief Retrieve the public instance corresponding to the private data
> - * \param[in] klass The public class name
>   *
>   * This macro is the counterpart of LIBCAMERA_D_PTR() for private data classes.
>   * It can be used in any member function of the private data class to create a

-- 
Regards,

Laurent Pinchart