summaryrefslogtreecommitdiff
path: root/src/libcamera
diff options
context:
space:
mode:
authorJacopo Mondi <jacopo@jmondi.org>2021-04-18 16:42:17 +0200
committerJacopo Mondi <jacopo@jmondi.org>2021-04-21 09:52:34 +0200
commit1fca6228fece89c9270ff1abb293fdf48f1b577b (patch)
treecd1aeaa7cf980d0703bbd16ce969a48b2586f751 /src/libcamera
parentd40430116b1b65d8deeeeea106368e20d8534a03 (diff)
libcamera: Drop argument from LIBCAMERA_DECLARE_PRIVATE
The LIBCAMERA_DECLARE_PRIVATE() macro, used by the library classes that inherit from libcamera::Extensible in order to implement the PIMPL pattern, expands to: public: \ class Private; \ friend class Private; The 'klass' argument is not used and it might confuse developers as it might hint that the class that defines the pattern's implementation can be freely named, while it is actually hardcoded to 'Private'. Drop the argument from the macro definition. Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com> Reviewed-by: Niklas Söderlund <niklas.soderlund@ragnatech.se> Reviewed-by: Hanlin Chen <hanlinchen@google.com> Signed-off-by: Jacopo Mondi <jacopo@jmondi.org>
Diffstat (limited to 'src/libcamera')
-rw-r--r--src/libcamera/class.cpp4
1 files changed, 1 insertions, 3 deletions
diff --git a/src/libcamera/class.cpp b/src/libcamera/class.cpp
index 340b7de7..171f7c0a 100644
--- a/src/libcamera/class.cpp
+++ b/src/libcamera/class.cpp
@@ -77,12 +77,10 @@ namespace libcamera {
/**
* \def LIBCAMERA_DECLARE_PRIVATE
* \brief Declare private data for a public class
- * \param klass The public class name
*
* The LIBCAMERA_DECLARE_PRIVATE() macro plumbs the infrastructure necessary to
* make a class manage its private data through a d-pointer. It shall be used at
- * the very top of the class definition, with the public class name passed as
- * the \a klass parameter.
+ * the very top of the class definition.
*/
/**