libcamera: stream: Document protected members

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

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

Fixes: 4e1dc9004fca ("libcamera: stream: Make Stream inheritable")
Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Signed-off-by: Jacopo Mondi <jacopo@jmondi.org>

1 files changed, 18 insertions, 0 deletions

diff --git a/src/libcamera/stream.cpp b/src/libcamera/stream.cpp
index 71dd461d..aeb479c5 100644
--- a/src/libcamera/stream.cpp
+++ b/src/libcamera/stream.cpp
@@ -211,4 +211,22 @@ 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 stream configuration
+ *
+ * The configuration for the stream is set by any successful call to
+ * Camera::configureStreams() that includes the stream, and remains valid until
+ * the next call to Camera::configureStreams() regardless of if it includes the
+ * stream.
+ */
+
 } /* namespace libcamera */