libcamera: class: Drop 'klass' argument from documentation

The LIBCAMERA_D_PTR() and LIBCAMERA_O_PTR() macros do not require an
argument, but the version of the macro consumed by Doxygen does.

Fix this by removing the klass parameter from both macros in their
documentation version.

Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Reviewed-by: Niklas Söderlund <niklas.soderlund@ragnatech.se>
Signed-off-by: Jacopo Mondi <jacopo@jmondi.org>
This commit is contained in:
Jacopo Mondi 2021-04-20 11:34:35 +02:00
parent 1fca6228fe
commit e58b5fa39f
2 changed files with 4 additions and 6 deletions

View file

@ -48,8 +48,8 @@ public: \
#else #else
#define LIBCAMERA_DECLARE_PRIVATE() #define LIBCAMERA_DECLARE_PRIVATE()
#define LIBCAMERA_DECLARE_PUBLIC(klass) #define LIBCAMERA_DECLARE_PUBLIC(klass)
#define LIBCAMERA_D_PTR(klass) #define LIBCAMERA_D_PTR()
#define LIBCAMERA_O_PTR(klass) #define LIBCAMERA_O_PTR()
#endif #endif
class Extensible class Extensible

View file

@ -95,9 +95,8 @@ namespace libcamera {
*/ */
/** /**
* \def LIBCAMERA_D_PTR(klass) * \def LIBCAMERA_D_PTR()
* \brief Retrieve the private data pointer * \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, * 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 * 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 * \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. * 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 * It can be used in any member function of the private data class to create a