[libcamera-devel] [PATCH] libcamera: pixel_format: remove duplicated return documentation

[Laurent Pinchart]

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 at ideasonboard.com>
> ---

Reviewed-by: Laurent Pinchart <laurent.pinchart at 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.
>   */

-- 
Regards,

Laurent Pinchart