summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJacopo Mondi <jacopo@jmondi.org>2019-04-18 17:13:26 +0200
committerJacopo Mondi <jacopo@jmondi.org>2019-04-19 14:10:15 +0200
commit323f21b56ba6e79f4aac0915f39ec317ada7e5fe (patch)
tree99b2c6d480c5180be6a5df24174dd503e404d8d1
parent1ba441cae6cf2355f6986b066b696111bec29bd7 (diff)
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>
-rw-r--r--src/libcamera/stream.cpp18
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 */