[libcamera-devel] [PATCH] libcamera: stream: Document protected members

[Jacopo Mondi]

Since commit:
4e1dc9004fca ("libcamera: stream: Make Stream inheritable")
the private members of the Stream class have been turned into protected,
to allows sub-class to access them.

As Doxygen generates documentation for protected members (but not
private ones), add documentation to the stream class for the
'bufferMap_' and 'configuration_' members.

Fixes: 4e1dc9004fca ("libcamera: stream: Make Stream inheritable")
Signed-off-by: Jacopo Mondi <jacopo at jmondi.org>
---
 src/libcamera/stream.cpp | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

diff --git a/src/libcamera/stream.cpp b/src/libcamera/stream.cpp
index 85cd5256ee2f..5839b983f45f 100644
--- a/src/libcamera/stream.cpp
+++ b/src/libcamera/stream.cpp
@@ -194,4 +194,21 @@ Stream::Stream()
  * \return The active configuration of the stream
  */
 
+/**
+ * \var Stream::bufferPool_
+ * \brief The pool of buffers associated with the stream
+ *
+ * The stream buffer pool is populated by the Camera class after a succesfull
+ * stream configuration.
+ */
+
+/**
+ * \var Stream::configuration_
+ * \brief The configuration associated with the stream
+ *
+ * The stream configuration is accessible only to Stream sub-classes and to
+ * the Camera class, that associates the Stream with the configuration returned
+ * by a succesfull PipelineHandler::configureStreams() call.
+ */
+
 } /* namespace libcamera */
-- 
2.21.0