Skip to contentSkip to conversation

drm: Add missing documentation for struct drm_plane_size_hint

PATCH Applied Mohammed Anees 2 participants 2 messages Aug 11, 2024 – Aug 12, 2024

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 drm: Add missing documentation for struct drm_plane_size_hint

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'

---
 include/uapi/drm/drm_mode.h | 2 ++
 1 file changed, 2 insertions(+)
include/uapi/drm/drm_mode.h +2 -0
index d390011b8..c082810c0 100644
@@ -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.
Signature · 1 line
2.43.0
#1 lore raw
Quoted 7 lines · Mohammed Anees

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'

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

Quoted 20 lines
---
 include/uapi/drm/drm_mode.h | 2 ++
 1 file changed, 2 insertions(+)
include/uapi/drm/drm_mode.h +2 -0
index d390011b8..c082810c0 100644
@@ -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.
Signature · 1 line
2.43.0
Signature · 3 lines
Daniel Vetter
Software Engineer, Intel Corporation
http://blog.ffwll.ch