diff mbox series

vpbe_osd.h/uvcvideo.h includes: fix trivial kernel-doc warnings

Message ID e184e57d-3739-98c6-6d64-adfc8f7c5777@xs4all.nl
State New
Headers show
Series vpbe_osd.h/uvcvideo.h includes: fix trivial kernel-doc warnings | expand

Commit Message

Hans Verkuil March 9, 2021, 12:22 p.m. UTC
Fix these kernel-doc warnings:

include/media/davinci/vpbe_osd.h:77: warning: Enum value 'PIXFMT_YCBCRI' not described in enum 'osd_pix_format'
include/media/davinci/vpbe_osd.h:77: warning: Enum value 'PIXFMT_YCRCBI' not described in enum 'osd_pix_format'
include/media/davinci/vpbe_osd.h:77: warning: Excess enum value 'PIXFMT_YCrCbI' description in 'osd_pix_format'
include/media/davinci/vpbe_osd.h:77: warning: Excess enum value 'PIXFMT_YCbCrI' description in 'osd_pix_format'
include/media/davinci/vpbe_osd.h:232: warning: expecting prototype for enum davinci_cursor_v_width. Prototype was for enum
osd_cursor_v_width instead
include/uapi/linux/uvcvideo.h:98: warning: Function parameter or member 'ns' not described in 'uvc_meta_buf'
include/uapi/linux/uvcvideo.h:98: warning: Function parameter or member 'sof' not described in 'uvc_meta_buf'
include/uapi/linux/uvcvideo.h:98: warning: Function parameter or member 'length' not described in 'uvc_meta_buf'
include/uapi/linux/uvcvideo.h:98: warning: Function parameter or member 'flags' not described in 'uvc_meta_buf'
include/uapi/linux/uvcvideo.h:98: warning: Function parameter or member 'buf' not described in 'uvc_meta_buf'

Signed-off-by: Hans Verkuil <hverkuil-cisco@xs4all.nl>
---

Comments

Laurent Pinchart March 9, 2021, 12:24 p.m. UTC | #1
Hi Hans,

Thank you for the patch.

On Tue, Mar 09, 2021 at 01:22:37PM +0100, Hans Verkuil wrote:
> Fix these kernel-doc warnings:
> 
> include/media/davinci/vpbe_osd.h:77: warning: Enum value 'PIXFMT_YCBCRI' not described in enum 'osd_pix_format'
> include/media/davinci/vpbe_osd.h:77: warning: Enum value 'PIXFMT_YCRCBI' not described in enum 'osd_pix_format'
> include/media/davinci/vpbe_osd.h:77: warning: Excess enum value 'PIXFMT_YCrCbI' description in 'osd_pix_format'
> include/media/davinci/vpbe_osd.h:77: warning: Excess enum value 'PIXFMT_YCbCrI' description in 'osd_pix_format'
> include/media/davinci/vpbe_osd.h:232: warning: expecting prototype for enum davinci_cursor_v_width. Prototype was for enum
> osd_cursor_v_width instead
> include/uapi/linux/uvcvideo.h:98: warning: Function parameter or member 'ns' not described in 'uvc_meta_buf'
> include/uapi/linux/uvcvideo.h:98: warning: Function parameter or member 'sof' not described in 'uvc_meta_buf'
> include/uapi/linux/uvcvideo.h:98: warning: Function parameter or member 'length' not described in 'uvc_meta_buf'
> include/uapi/linux/uvcvideo.h:98: warning: Function parameter or member 'flags' not described in 'uvc_meta_buf'
> include/uapi/linux/uvcvideo.h:98: warning: Function parameter or member 'buf' not described in 'uvc_meta_buf'
> 
> Signed-off-by: Hans Verkuil <hverkuil-cisco@xs4all.nl>

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

> ---
> diff --git a/include/media/davinci/vpbe_osd.h b/include/media/davinci/vpbe_osd.h
> index e1b1c76aa50f..a4fc4f2a56fb 100644
> --- a/include/media/davinci/vpbe_osd.h
> +++ b/include/media/davinci/vpbe_osd.h
> @@ -54,9 +54,9 @@ enum osd_win_layer {
>   * @PIXFMT_4BPP: 4-bits-per-pixel bitmap
>   * @PIXFMT_8BPP: 8-bits-per-pixel bitmap
>   * @PIXFMT_RGB565: 16-bits-per-pixel RGB565
> - * @PIXFMT_YCbCrI: YUV 4:2:2
> + * @PIXFMT_YCBCRI: YUV 4:2:2
>   * @PIXFMT_RGB888: 24-bits-per-pixel RGB888
> - * @PIXFMT_YCrCbI: YUV 4:2:2 with chroma swap
> + * @PIXFMT_YCRCBI: YUV 4:2:2 with chroma swap
>   * @PIXFMT_NV12: YUV 4:2:0 planar
>   * @PIXFMT_OSD_ATTR: OSD Attribute Window pixel format (4bpp)
>   *
> @@ -210,7 +210,7 @@ enum osd_cursor_h_width {
>  };
> 
>  /**
> - * enum davinci_cursor_v_width
> + * enum osd_cursor_v_width
>   * @V_WIDTH_1: vertical line width is 1 line
>   * @V_WIDTH_2: vertical line width is 2 lines
>   * @V_WIDTH_4: vertical line width is 4 lines
> diff --git a/include/uapi/linux/uvcvideo.h b/include/uapi/linux/uvcvideo.h
> index f80f05b3c423..8288137387c0 100644
> --- a/include/uapi/linux/uvcvideo.h
> +++ b/include/uapi/linux/uvcvideo.h
> @@ -76,11 +76,11 @@ struct uvc_xu_control_query {
> 
>  /**
>   * struct uvc_meta_buf - metadata buffer building block
> - * @ns		- system timestamp of the payload in nanoseconds
> - * @sof		- USB Frame Number
> - * @length	- length of the payload header
> - * @flags	- payload header flags
> - * @buf		- optional device-specific header data
> + * @ns: system timestamp of the payload in nanoseconds
> + * @sof: USB Frame Number
> + * @length: length of the payload header
> + * @flags: payload header flags
> + * @buf: optional device-specific header data
>   *
>   * UVC metadata nodes fill buffers with possibly multiple instances of this
>   * struct. The first two fields are added by the driver, they can be used for
Prabhakar March 10, 2021, 12:41 p.m. UTC | #2
Hi Hans,

Thank you for the patch.

On Tue, Mar 9, 2021 at 12:22 PM Hans Verkuil <hverkuil@xs4all.nl> wrote:
>

> Fix these kernel-doc warnings:

>

> include/media/davinci/vpbe_osd.h:77: warning: Enum value 'PIXFMT_YCBCRI' not described in enum 'osd_pix_format'

> include/media/davinci/vpbe_osd.h:77: warning: Enum value 'PIXFMT_YCRCBI' not described in enum 'osd_pix_format'

> include/media/davinci/vpbe_osd.h:77: warning: Excess enum value 'PIXFMT_YCrCbI' description in 'osd_pix_format'

> include/media/davinci/vpbe_osd.h:77: warning: Excess enum value 'PIXFMT_YCbCrI' description in 'osd_pix_format'

> include/media/davinci/vpbe_osd.h:232: warning: expecting prototype for enum davinci_cursor_v_width. Prototype was for enum

> osd_cursor_v_width instead

> include/uapi/linux/uvcvideo.h:98: warning: Function parameter or member 'ns' not described in 'uvc_meta_buf'

> include/uapi/linux/uvcvideo.h:98: warning: Function parameter or member 'sof' not described in 'uvc_meta_buf'

> include/uapi/linux/uvcvideo.h:98: warning: Function parameter or member 'length' not described in 'uvc_meta_buf'

> include/uapi/linux/uvcvideo.h:98: warning: Function parameter or member 'flags' not described in 'uvc_meta_buf'

> include/uapi/linux/uvcvideo.h:98: warning: Function parameter or member 'buf' not described in 'uvc_meta_buf'

>

> Signed-off-by: Hans Verkuil <hverkuil-cisco@xs4all.nl>

> ---

> diff --git a/include/media/davinci/vpbe_osd.h b/include/media/davinci/vpbe_osd.h

> index e1b1c76aa50f..a4fc4f2a56fb 100644

> --- a/include/media/davinci/vpbe_osd.h

> +++ b/include/media/davinci/vpbe_osd.h

> @@ -54,9 +54,9 @@ enum osd_win_layer {

>   * @PIXFMT_4BPP: 4-bits-per-pixel bitmap

>   * @PIXFMT_8BPP: 8-bits-per-pixel bitmap

>   * @PIXFMT_RGB565: 16-bits-per-pixel RGB565

> - * @PIXFMT_YCbCrI: YUV 4:2:2

> + * @PIXFMT_YCBCRI: YUV 4:2:2

>   * @PIXFMT_RGB888: 24-bits-per-pixel RGB888

> - * @PIXFMT_YCrCbI: YUV 4:2:2 with chroma swap

> + * @PIXFMT_YCRCBI: YUV 4:2:2 with chroma swap

>   * @PIXFMT_NV12: YUV 4:2:0 planar

>   * @PIXFMT_OSD_ATTR: OSD Attribute Window pixel format (4bpp)

>   *

> @@ -210,7 +210,7 @@ enum osd_cursor_h_width {

>  };

>

>  /**

> - * enum davinci_cursor_v_width

> + * enum osd_cursor_v_width

>   * @V_WIDTH_1: vertical line width is 1 line

>   * @V_WIDTH_2: vertical line width is 2 lines

>   * @V_WIDTH_4: vertical line width is 4 lines


For the above:

Reviewed-by: Lad Prabhakar <prabhakar.csengg@gmail.com>


Cheers,
Prabhakar

> diff --git a/include/uapi/linux/uvcvideo.h b/include/uapi/linux/uvcvideo.h

> index f80f05b3c423..8288137387c0 100644

> --- a/include/uapi/linux/uvcvideo.h

> +++ b/include/uapi/linux/uvcvideo.h

> @@ -76,11 +76,11 @@ struct uvc_xu_control_query {

>

>  /**

>   * struct uvc_meta_buf - metadata buffer building block

> - * @ns         - system timestamp of the payload in nanoseconds

> - * @sof                - USB Frame Number

> - * @length     - length of the payload header

> - * @flags      - payload header flags

> - * @buf                - optional device-specific header data

> + * @ns: system timestamp of the payload in nanoseconds

> + * @sof: USB Frame Number

> + * @length: length of the payload header

> + * @flags: payload header flags

> + * @buf: optional device-specific header data

>   *

>   * UVC metadata nodes fill buffers with possibly multiple instances of this

>   * struct. The first two fields are added by the driver, they can be used for
diff mbox series

Patch

diff --git a/include/media/davinci/vpbe_osd.h b/include/media/davinci/vpbe_osd.h
index e1b1c76aa50f..a4fc4f2a56fb 100644
--- a/include/media/davinci/vpbe_osd.h
+++ b/include/media/davinci/vpbe_osd.h
@@ -54,9 +54,9 @@  enum osd_win_layer {
  * @PIXFMT_4BPP: 4-bits-per-pixel bitmap
  * @PIXFMT_8BPP: 8-bits-per-pixel bitmap
  * @PIXFMT_RGB565: 16-bits-per-pixel RGB565
- * @PIXFMT_YCbCrI: YUV 4:2:2
+ * @PIXFMT_YCBCRI: YUV 4:2:2
  * @PIXFMT_RGB888: 24-bits-per-pixel RGB888
- * @PIXFMT_YCrCbI: YUV 4:2:2 with chroma swap
+ * @PIXFMT_YCRCBI: YUV 4:2:2 with chroma swap
  * @PIXFMT_NV12: YUV 4:2:0 planar
  * @PIXFMT_OSD_ATTR: OSD Attribute Window pixel format (4bpp)
  *
@@ -210,7 +210,7 @@  enum osd_cursor_h_width {
 };

 /**
- * enum davinci_cursor_v_width
+ * enum osd_cursor_v_width
  * @V_WIDTH_1: vertical line width is 1 line
  * @V_WIDTH_2: vertical line width is 2 lines
  * @V_WIDTH_4: vertical line width is 4 lines
diff --git a/include/uapi/linux/uvcvideo.h b/include/uapi/linux/uvcvideo.h
index f80f05b3c423..8288137387c0 100644
--- a/include/uapi/linux/uvcvideo.h
+++ b/include/uapi/linux/uvcvideo.h
@@ -76,11 +76,11 @@  struct uvc_xu_control_query {

 /**
  * struct uvc_meta_buf - metadata buffer building block
- * @ns		- system timestamp of the payload in nanoseconds
- * @sof		- USB Frame Number
- * @length	- length of the payload header
- * @flags	- payload header flags
- * @buf		- optional device-specific header data
+ * @ns: system timestamp of the payload in nanoseconds
+ * @sof: USB Frame Number
+ * @length: length of the payload header
+ * @flags: payload header flags
+ * @buf: optional device-specific header data
  *
  * UVC metadata nodes fill buffers with possibly multiple instances of this
  * struct. The first two fields are added by the driver, they can be used for