[libcamera-devel] libcamera: StreamConfiguration: Fix typo in documentation

Message ID 20200616105400.57377-1-paul.elder@ideasonboard.com
State Accepted
Commit 967f77054cfe7828a4dba9fb4fad2d35b5c3882b
Headers show
Series
  • [libcamera-devel] libcamera: StreamConfiguration: Fix typo in documentation
Related show

Commit Message

Paul Elder June 16, 2020, 10:54 a.m. UTC
Fix a typo in the documentation in the StreamConfiguration constructor.

Signed-off-by: Paul Elder <paul.elder@ideasonboard.com>
---
 src/libcamera/stream.cpp | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Umang Jain June 16, 2020, 2:30 p.m. UTC | #1
Hi Paul,

Thank you for the patch.

On 6/16/20 4:24 PM, Paul Elder wrote:
> Fix a typo in the documentation in the StreamConfiguration constructor.
>
> Signed-off-by: Paul Elder <paul.elder@ideasonboard.com>
> ---
>   src/libcamera/stream.cpp | 2 +-
>   1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/src/libcamera/stream.cpp b/src/libcamera/stream.cpp
> index f34348f..8e78234 100644
> --- a/src/libcamera/stream.cpp
> +++ b/src/libcamera/stream.cpp
> @@ -276,7 +276,7 @@ SizeRange StreamFormats::range(const PixelFormat &pixelformat) const
>   
>   /**
>    * \todo This method is deprecated and should be removed once all pipeline
> - * handlers provied StreamFormats.
> + * handlers provide StreamFormats.
>    */
>   StreamConfiguration::StreamConfiguration()
>   	: pixelFormat(0), stream_(nullptr)

Looks good to me.

Reviewed-by: Umang Jain <email@uajain.com>
Laurent Pinchart June 17, 2020, 12:30 a.m. UTC | #2
Hi Paul,

Thank you for the patch.

On Tue, Jun 16, 2020 at 07:54:00PM +0900, Paul Elder wrote:
> Fix a typo in the documentation in the StreamConfiguration constructor.
> 
> Signed-off-by: Paul Elder <paul.elder@ideasonboard.com>
> ---
>  src/libcamera/stream.cpp | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/src/libcamera/stream.cpp b/src/libcamera/stream.cpp
> index f34348f..8e78234 100644
> --- a/src/libcamera/stream.cpp
> +++ b/src/libcamera/stream.cpp
> @@ -276,7 +276,7 @@ SizeRange StreamFormats::range(const PixelFormat &pixelformat) const
>  
>  /**
>   * \todo This method is deprecated and should be removed once all pipeline
> - * handlers provied StreamFormats.
> + * handlers provide StreamFormats.
>   */
>  StreamConfiguration::StreamConfiguration()
>  	: pixelFormat(0), stream_(nullptr)

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

Patch

diff --git a/src/libcamera/stream.cpp b/src/libcamera/stream.cpp
index f34348f..8e78234 100644
--- a/src/libcamera/stream.cpp
+++ b/src/libcamera/stream.cpp
@@ -276,7 +276,7 @@  SizeRange StreamFormats::range(const PixelFormat &pixelformat) const
 
 /**
  * \todo This method is deprecated and should be removed once all pipeline
- * handlers provied StreamFormats.
+ * handlers provide StreamFormats.
  */
 StreamConfiguration::StreamConfiguration()
 	: pixelFormat(0), stream_(nullptr)