[PATCH] libcamera: formats: Fix typos in PixelFormatInfo documentation

Stefan Klug stefan.klug at ideasonboard.com
Wed Mar 6 15:45:10 CET 2024


Hi Laurent,

On Tue, Feb 27, 2024 at 12:10:22PM +0200, Laurent Pinchart wrote:
> The PixelFormatInfo documentation has typo. Fix two of them.
> 
> Signed-off-by: Laurent Pinchart <laurent.pinchart at ideasonboard.com>

Reviewed-by: Stefan Klug<stefan.klug at ideasonboard.com>

Cheers,
Stefan

> ---
>  src/libcamera/formats.cpp | 8 ++++----
>  1 file changed, 4 insertions(+), 4 deletions(-)
> 
> diff --git a/src/libcamera/formats.cpp b/src/libcamera/formats.cpp
> index 8a606a7c37f1..6a3b89a38cc0 100644
> --- a/src/libcamera/formats.cpp
> +++ b/src/libcamera/formats.cpp
> @@ -33,7 +33,7 @@ LOG_DEFINE_CATEGORY(Formats)
>   * used in pipeline handlers.
>   *
>   * \var PixelFormatInfo::name
> - * \brief The format name as a human-readable string, used as the test
> + * \brief The format name as a human-readable string, used as the text
>   * representation of the PixelFormat
>   *
>   * \var PixelFormatInfo::format
> @@ -49,9 +49,9 @@ LOG_DEFINE_CATEGORY(Formats)
>   * \var PixelFormatInfo::bitsPerPixel
>   * \brief The average number of bits per pixel
>   *
> - * The number per pixel averages the total number of bits for all colour
> - * components over the whole image, excluding any padding bits or padding
> - * pixels.
> + * The number of bits per pixel averages the total number of bits for all
> + * colour components over the whole image, excluding any padding bits or
> + * padding pixels.
>   *
>   * For formats that store pixels with bit padding within words, only the
>   * effective bits are taken into account. For instance, 12-bit Bayer data
> -- 
> Regards,
> 
> Laurent Pinchart
> 


More information about the libcamera-devel mailing list