[libcamera-devel] [RFC PATCH 02/17] libcamera: base: class: Link LIBCAMERA_O_PTR to Extensible documentation

[Laurent Pinchart]

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 at ideasonboard.com>
---
 src/libcamera/base/class.cpp | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)

diff --git a/src/libcamera/base/class.cpp b/src/libcamera/base/class.cpp
index d0899671ca11..d4f0ac64ad48 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.
  */
 
 /**
-- 
Regards,

Laurent Pinchart