diff options
| author | Laurent Pinchart <laurent.pinchart@ideasonboard.com> | 2021-07-23 06:06:28 +0300 |
|---|---|---|
| committer | Laurent Pinchart <laurent.pinchart@ideasonboard.com> | 2021-08-03 23:05:08 +0300 |
| commit | 960b1b2e879e2b876f1e7b92318a4161e7d0964d (patch) | |
| tree | 08d7c9ff2caac537319d3ef5a114f0b1ecfba70c | |
| parent | 6a8582dc20eedeba90431fa1ab1ba2ee432f5bbc (diff) | |
libcamera: base: class: Document Extensible::_d() functions
The Extensible::_d() functions are meant to be called by users of the
class. Document them.
Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Reviewed-by: Niklas Söderlund <niklas.soderlund@ragnatech.se>
Reviewed-by: Jacopo Mondi <jacopo@jmondi.org>
| -rw-r--r-- | include/libcamera/base/class.h | 2 | ||||
| -rw-r--r-- | src/libcamera/base/class.cpp | 17 |
2 files changed, 17 insertions, 2 deletions
diff --git a/include/libcamera/base/class.h b/include/libcamera/base/class.h index c2e1d353..9c7f0f2e 100644 --- a/include/libcamera/base/class.h +++ b/include/libcamera/base/class.h @@ -88,7 +88,6 @@ public: Extensible(Private *d); protected: -#ifndef __DOXYGEN__ template<typename T> const T *_d() const { @@ -100,7 +99,6 @@ protected: { return static_cast<T *>(d_.get()); } -#endif private: const std::unique_ptr<Private> d_; diff --git a/src/libcamera/base/class.cpp b/src/libcamera/base/class.cpp index 26b49677..d0899671 100644 --- a/src/libcamera/base/class.cpp +++ b/src/libcamera/base/class.cpp @@ -151,6 +151,23 @@ Extensible::Extensible(Extensible::Private *d) } /** + * \fn Extensible::_d() const + * \brief Retrieve the private data instance + * + * This template function isn't meant to be called directly. Instead, classes + * derived from Extensible get, through the LIBCAMERA_DECLARE_PRIVATE() macro, + * overriden _d() functions that return the correct pointer type to the + * corresponding derived Private class. + * + * \return A pointer to the private data instance + */ + +/** + * \fn Extensible::_d() + * \copydoc Extensible::_d() const + */ + +/** * \var Extensible::d_ * \brief Pointer to the private data instance */ |