[libcamera-devel] libcamera: pixel_format: remove duplicated return documentation
diff mbox series

Message ID 20211027131113.2275437-1-kieran.bingham@ideasonboard.com
State Accepted
Commit 76bd9f3d80cb99a3391832b644b65a619427ed00
Headers show
Series
  • [libcamera-devel] libcamera: pixel_format: remove duplicated return documentation
Related show

Commit Message

Kieran Bingham Oct. 27, 2021, 1:11 p.m. UTC
The PixelFormat::toString() has two \return statements in its
doxygen documentation.

Remove the redundant one.

Signed-off-by: Kieran Bingham <kieran.bingham@ideasonboard.com>
---
 src/libcamera/pixel_format.cpp | 1 -
 1 file changed, 1 deletion(-)

Comments

Umang Jain Oct. 27, 2021, 1:14 p.m. UTC | #1
Hello,

Thank you for the patch

On 10/27/21 6:41 PM, Kieran Bingham wrote:
> The PixelFormat::toString() has two \return statements in its
> doxygen documentation.
>
> Remove the redundant one.
>
> Signed-off-by: Kieran Bingham <kieran.bingham@ideasonboard.com>


Reviewed-by: Umang Jain <umang.jain@ideasonboard.com>

> ---
>   src/libcamera/pixel_format.cpp | 1 -
>   1 file changed, 1 deletion(-)
>
> diff --git a/src/libcamera/pixel_format.cpp b/src/libcamera/pixel_format.cpp
> index 54763fbf8e33..997aeb8a9290 100644
> --- a/src/libcamera/pixel_format.cpp
> +++ b/src/libcamera/pixel_format.cpp
> @@ -132,7 +132,6 @@ std::string PixelFormat::toString() const
>   
>   /**
>    * \brief Create a PixelFormat from a string
> - * \return Pixel format
>    * \return The PixelFormat represented by the \a name if known, or an
>    * invalid pixel format otherwise.
>    */
Laurent Pinchart Oct. 27, 2021, 1:18 p.m. UTC | #2
Hi Kieran,

Thank you for the patch.

On Wed, Oct 27, 2021 at 02:11:13PM +0100, Kieran Bingham wrote:
> The PixelFormat::toString() has two \return statements in its
> doxygen documentation.

I would have expected doxygen to warn about that.

> Remove the redundant one.
> 
> Signed-off-by: Kieran Bingham <kieran.bingham@ideasonboard.com>
> ---

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

>  src/libcamera/pixel_format.cpp | 1 -
>  1 file changed, 1 deletion(-)
> 
> diff --git a/src/libcamera/pixel_format.cpp b/src/libcamera/pixel_format.cpp
> index 54763fbf8e33..997aeb8a9290 100644
> --- a/src/libcamera/pixel_format.cpp
> +++ b/src/libcamera/pixel_format.cpp
> @@ -132,7 +132,6 @@ std::string PixelFormat::toString() const
>  
>  /**
>   * \brief Create a PixelFormat from a string
> - * \return Pixel format
>   * \return The PixelFormat represented by the \a name if known, or an
>   * invalid pixel format otherwise.
>   */

Patch
diff mbox series

diff --git a/src/libcamera/pixel_format.cpp b/src/libcamera/pixel_format.cpp
index 54763fbf8e33..997aeb8a9290 100644
--- a/src/libcamera/pixel_format.cpp
+++ b/src/libcamera/pixel_format.cpp
@@ -132,7 +132,6 @@  std::string PixelFormat::toString() const
 
 /**
  * \brief Create a PixelFormat from a string
- * \return Pixel format
  * \return The PixelFormat represented by the \a name if known, or an
  * invalid pixel format otherwise.
  */