diff mbox series

drm: Add missing documentation for struct drm_plane_size_hint

Message ID 20240811101653.170223-1-pvmohammedanees2003@gmail.com (mailing list archive)
State New, archived
Headers show
Series drm: Add missing documentation for struct drm_plane_size_hint | expand

Commit Message

Mohammed Anees Aug. 11, 2024, 10:16 a.m. UTC
This patch takes care of the following warnings during documentation
compiling:

./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: Mohammed Anees <pvmohammedanees2003@gmail.com>
---
 include/uapi/drm/drm_mode.h | 2 ++
 1 file changed, 2 insertions(+)

Comments

Daniel Vetter Aug. 12, 2024, 9:16 a.m. UTC | #1
On Sun, Aug 11, 2024 at 06:16:51AM -0400, Mohammed Anees wrote:
> This patch takes care of the following warnings during documentation
> compiling:
> 
> ./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: Mohammed Anees <pvmohammedanees2003@gmail.com>

Applied to drm-misc-next, thanks.
-sima

> ---
>  include/uapi/drm/drm_mode.h | 2 ++
>  1 file changed, 2 insertions(+)
> 
> diff --git a/include/uapi/drm/drm_mode.h b/include/uapi/drm/drm_mode.h
> index d390011b8..c082810c0 100644
> --- a/include/uapi/drm/drm_mode.h
> +++ b/include/uapi/drm/drm_mode.h
> @@ -859,6 +859,8 @@ struct drm_color_lut {
>  
>  /**
>   * struct drm_plane_size_hint - Plane size hints
> + * @width: The width of the plane in pixel
> + * @height: The height of the plane in pixel
>   *
>   * The plane SIZE_HINTS property blob contains an
>   * array of struct drm_plane_size_hint.
> -- 
> 2.43.0
>
diff mbox series

Patch

diff --git a/include/uapi/drm/drm_mode.h b/include/uapi/drm/drm_mode.h
index d390011b8..c082810c0 100644
--- a/include/uapi/drm/drm_mode.h
+++ b/include/uapi/drm/drm_mode.h
@@ -859,6 +859,8 @@  struct drm_color_lut {
 
 /**
  * struct drm_plane_size_hint - Plane size hints
+ * @width: The width of the plane in pixel
+ * @height: The height of the plane in pixel
  *
  * The plane SIZE_HINTS property blob contains an
  * array of struct drm_plane_size_hint.