From 49334e1f24b1a99456615d76061812eab9e45b0b Mon Sep 17 00:00:00 2001 From: Laurent Pinchart Date: Fri, 23 Jul 2021 06:06:28 +0300 Subject: libcamera: base: class: Link LIBCAMERA_O_PTR to Extensible documentation MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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 Reviewed-by: Niklas Söderlund Reviewed-by: Jacopo Mondi --- src/libcamera/base/class.cpp | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) (limited to 'src') 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. */ /** -- cgit v1.2.1