summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLaurent Pinchart <laurent.pinchart@ideasonboard.com>2021-07-23 06:06:28 +0300
committerLaurent Pinchart <laurent.pinchart@ideasonboard.com>2021-08-03 23:05:08 +0300
commit49334e1f24b1a99456615d76061812eab9e45b0b (patch)
tree7abdc50a3dd0dcf43cedd2e05f10bcb62a936c1f
parent960b1b2e879e2b876f1e7b92318a4161e7d0964d (diff)
libcamera: base: class: Link LIBCAMERA_O_PTR to Extensible documentation
The LIBCAMERA_O_PTR macro is part of the Extensible class infrastructure, but doesn't link to it. This makes the generated documentation unclear. Fix it. 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--src/libcamera/base/class.cpp7
1 files changed, 5 insertions, 2 deletions
diff --git a/src/libcamera/base/class.cpp b/src/libcamera/base/class.cpp
index d0899671..d4f0ac64 100644
--- a/src/libcamera/base/class.cpp
+++ b/src/libcamera/base/class.cpp
@@ -98,8 +98,9 @@ namespace libcamera {
* \def LIBCAMERA_O_PTR()
* \brief Retrieve the public instance corresponding to the private data
*
- * This macro is used in any member function of the private data class to access
- * the public class instance corresponding to the private data.
+ * This macro is part of the libcamera::Extensible class infrastructure. It may
+ * be used in any member function of a libcamera::Extensible::Private subclass
+ * to access the public class instance corresponding to the private data.
*/
/**
@@ -139,6 +140,8 @@ namespace libcamera {
* protected and private members.
*
* The PublicClass exposes its Private data pointer through the _d() function.
+ * In the other direction, the pointer to the PublicClass can be retrieved in
+ * functions of the Private class using the LIBCAMERA_O_PTR() macro.
*/
/**