diff mbox series

drm: Add documentation for struct drm_pane_size_hint

Message ID 20240801102239.572718-1-sayyad.abid16@gmail.com (mailing list archive)
State New, archived
Headers show
Series drm: Add documentation for struct drm_pane_size_hint | expand

Commit Message

Sayyad Abid Aug. 1, 2024, 10:22 a.m. UTC
Fixed warning for the following:
./include/uapi/drm/drm_mode.h:869: warning: Function parameter or struct member
				'width' not described in 'drm_plane_size_hint'
./include/uapi/drm/drm_mode.h:869: warning: Function parameter or struct member
				'height' not described in 'drm_plane_size_hint'

Signed-off-by: abid-sayyad <sayyad.abid16@gmail.com>
---
 include/uapi/drm/drm_mode.h | 6 ++++++
 1 file changed, 6 insertions(+)

Comments

Jani Nikula Aug. 1, 2024, 11:10 a.m. UTC | #1
On Thu, 01 Aug 2024, abid-sayyad <sayyad.abid16@gmail.com> wrote:
> Fixed warning for the following:
> ./include/uapi/drm/drm_mode.h:869: warning: Function parameter or struct member
> 				'width' not described in 'drm_plane_size_hint'
> ./include/uapi/drm/drm_mode.h:869: warning: Function parameter or struct member
> 				'height' not described in 'drm_plane_size_hint'
>
> Signed-off-by: abid-sayyad <sayyad.abid16@gmail.com>
> ---
>  include/uapi/drm/drm_mode.h | 6 ++++++
>  1 file changed, 6 insertions(+)
>
> diff --git a/include/uapi/drm/drm_mode.h b/include/uapi/drm/drm_mode.h
> index d390011b89b4..b581d384d4b5 100644
> --- a/include/uapi/drm/drm_mode.h
> +++ b/include/uapi/drm/drm_mode.h
> @@ -864,7 +864,13 @@ struct drm_color_lut {
>   * array of struct drm_plane_size_hint.
>   */
>  struct drm_plane_size_hint {
> +	/**
> +	 * @width : width of the plane in pixels.

Please no space before :.

BR,
Jani.

> +	 */
>  	__u16 width;
> +	/**
> +	 * @height : height of the plane in pixels.
> +	 */
>  	__u16 height;
>  };
diff mbox series

Patch

diff --git a/include/uapi/drm/drm_mode.h b/include/uapi/drm/drm_mode.h
index d390011b89b4..b581d384d4b5 100644
--- a/include/uapi/drm/drm_mode.h
+++ b/include/uapi/drm/drm_mode.h
@@ -864,7 +864,13 @@  struct drm_color_lut {
  * array of struct drm_plane_size_hint.
  */
 struct drm_plane_size_hint {
+	/**
+	 * @width : width of the plane in pixels.
+	 */
 	__u16 width;
+	/**
+	 * @height : height of the plane in pixels.
+	 */
 	__u16 height;
 };