summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJacopo Mondi <jacopo@jmondi.org>2021-04-20 11:34:35 +0200
committerJacopo Mondi <jacopo@jmondi.org>2021-04-21 09:53:08 +0200
commite58b5fa39f1e4b6d86ebc40cdf17d7dc9030e661 (patch)
treea08a9bcd2205b8afbf15274a34d62ad46a929524
parent1fca6228fece89c9270ff1abb293fdf48f1b577b (diff)
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>
-rw-r--r--include/libcamera/class.h4
-rw-r--r--src/libcamera/class.cpp6
2 files changed, 4 insertions, 6 deletions
diff --git a/include/libcamera/class.h b/include/libcamera/class.h
index 466114ec..f384a488 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 171f7c0a..28c35633 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