[libcamera-devel,1/2] libcamera: media_device: Tiny valid() documentation improvement

Message ID 20190102110016.5489-1-jacopo@jmondi.org
State Accepted
Headers show
Series
  • [libcamera-devel,1/2] libcamera: media_device: Tiny valid() documentation improvement
Related show

Commit Message

Jacopo Mondi Jan. 2, 2019, 11 a.m. UTC
Mention in the valid() method documentation, that a media graph has to
be populated to be valid.

Signed-off-by: Jacopo Mondi <jacopo@jmondi.org>
---
 src/libcamera/media_device.cpp | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

--
2.20.1

Comments

Laurent Pinchart Jan. 2, 2019, 11:11 a.m. UTC | #1
Hi Jacopo,

Thank you for the patch.

On Wednesday, 2 January 2019 13:00:15 EET Jacopo Mondi wrote:
> Mention in the valid() method documentation, that a media graph has to
> be populated to be valid.
> 
> Signed-off-by: Jacopo Mondi <jacopo@jmondi.org>

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

Please push.

> ---
>  src/libcamera/media_device.cpp | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/src/libcamera/media_device.cpp b/src/libcamera/media_device.cpp
> index 1bd4f43..9fbc5a7 100644
> --- a/src/libcamera/media_device.cpp
> +++ b/src/libcamera/media_device.cpp
> @@ -216,7 +216,7 @@ int MediaDevice::populate()
> 
>  /**
>   * \fn MediaDevice::valid()
> - * \brief Query whether the media graph is valid
> + * \brief Query whether the media graph has been populated and is valid
>   * \return true if the media graph is valid, false otherwise
>   */

Patch

diff --git a/src/libcamera/media_device.cpp b/src/libcamera/media_device.cpp
index 1bd4f43..9fbc5a7 100644
--- a/src/libcamera/media_device.cpp
+++ b/src/libcamera/media_device.cpp
@@ -216,7 +216,7 @@  int MediaDevice::populate()

 /**
  * \fn MediaDevice::valid()
- * \brief Query whether the media graph is valid
+ * \brief Query whether the media graph has been populated and is valid
  * \return true if the media graph is valid, false otherwise
  */