Re: [PATCH] include: uapi: drm: drm_mode: fix documentation and coding style issue

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



On 8/21/24 14:20, Nihar Chaithanya wrote:
Fix documentation and coding style issue in include/uapi/drm/drm_mode.h.
Changes include:
- Adding description of function parameter.
- Correcting block comment style.

Fix documentation warnings in include/uapi/drm/drm_mode.h encountered
from make htmldocs:
./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'

Fix coding style warning in include/uapi/drm/drm_mode.h reported
by checkpatch.pl:
WARNING: Block comments use a trailing */ on a separate line

Signed-off-by: Nihar Chaithanya <niharchaithanya@xxxxxxxxx>
---
  include/uapi/drm/drm_mode.h | 5 ++++-
  1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/include/uapi/drm/drm_mode.h b/include/uapi/drm/drm_mode.h
index d390011b89b4..bbdba76a5d25 100644
--- a/include/uapi/drm/drm_mode.h
+++ b/include/uapi/drm/drm_mode.h
@@ -147,7 +147,8 @@ extern "C" {
/* Scaling mode options */
  #define DRM_MODE_SCALE_NONE		0 /* Unmodified timing (display or
-					     software can still scale) */
+					   * software can still scale)
+					   */
  #define DRM_MODE_SCALE_FULLSCREEN	1 /* Full screen, ignore aspect */
  #define DRM_MODE_SCALE_CENTER		2 /* Centered, no scaling */
  #define DRM_MODE_SCALE_ASPECT		3 /* Full screen, preserve aspect */
@@ -864,7 +865,9 @@ 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;
  };

Reviewed-by: Shuah Khan <skhan@xxxxxxxxxxxxxxxxxxx>

thanks,
-- Shuah



[Index of Archives]     [Linux DRI Users]     [Linux Intel Graphics]     [Linux USB Devel]     [Video for Linux]     [Linux Audio Users]     [Yosemite News]     [Linux Kernel]     [Linux SCSI]     [XFree86]     [Linux USB Devel]     [Video for Linux]     [Linux Audio Users]     [Linux Kernel]     [Linux SCSI]     [XFree86]
  Powered by Linux