From 5694a6791f8b1d04de9c42a34a0b63b0bb635d7c Mon Sep 17 00:00:00 2001 From: Laurent Pinchart Date: Fri, 23 Jul 2021 05:13:17 +0300 Subject: libcamera: frame_buffer: Document the FrameBuffer::Private class MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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 Reviewed-by: Niklas Söderlund Reviewed-by: Jacopo Mondi --- src/libcamera/framebuffer.cpp | 10 ++++++++++ 1 file changed, 10 insertions(+) (limited to 'src') 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) { -- cgit v1.2.1