summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLaurent Pinchart <laurent.pinchart@ideasonboard.com>2021-07-23 05:13:17 +0300
committerLaurent Pinchart <laurent.pinchart@ideasonboard.com>2021-08-03 23:05:09 +0300
commit5694a6791f8b1d04de9c42a34a0b63b0bb635d7c (patch)
treebbd67345d014b78c1fc646d101d45a0dff5eff04
parent33dd4fab9d39726be4fcbd300a27f2640be1cd6f (diff)
libcamera: frame_buffer: Document the FrameBuffer::Private class
The FrameBuffer::Private class is exposed to pipeline handlers, and is thus part of the internal libcamera API. As such, it should be documented. 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/framebuffer.cpp10
1 files changed, 10 insertions, 0 deletions
diff --git a/src/libcamera/framebuffer.cpp b/src/libcamera/framebuffer.cpp
index 48d14b31..a59e93fb 100644
--- a/src/libcamera/framebuffer.cpp
+++ b/src/libcamera/framebuffer.cpp
@@ -100,6 +100,16 @@ LOG_DEFINE_CATEGORY(Buffer)
* \brief Array of per-plane metadata
*/
+/**
+ * \class FrameBuffer::Private
+ * \brief Base class for FrameBuffer private data
+ *
+ * The FrameBuffer::Private class stores all private data associated with a
+ * framebuffer. It implements the d-pointer design pattern to hide core
+ * FrameBuffer data from the public API, and exposes utility functions to
+ * pipeline handlers.
+ */
+
FrameBuffer::Private::Private()
: request_(nullptr)
{