[libcamera-devel] [PATCH v7 1/8] libcamera: stream: Document protected members

[Laurent Pinchart]

Hi Jacopo,

Thank you for the patch.

On Fri, Apr 19, 2019 at 12:18:32PM +0200, Jacopo Mondi wrote:
> 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")
> Signed-off-by: Jacopo Mondi <jacopo at jmondi.org>

Reviewed-by: Laurent Pinchart <laurent.pinchart at ideasonboard.com>

> ---
>  src/libcamera/stream.cpp | 18 ++++++++++++++++++
>  1 file changed, 18 insertions(+)
> 
> diff --git a/src/libcamera/stream.cpp b/src/libcamera/stream.cpp
> index 85cd5256ee2f..aeb56fc1cadf 100644
> --- a/src/libcamera/stream.cpp
> +++ b/src/libcamera/stream.cpp
> @@ -194,4 +194,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 */

-- 
Regards,

Laurent Pinchart