include: uapi: drm: drm_mode: fix documentation and coding style issue
Subsystems (2)
PATCH 1/1 include: uapi: drm: drm_mode: fix documentation and coding style issue
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
--- include/uapi/drm/drm_mode.h | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-)
include/uapi/drm/drm_mode.h +4 -1
@@ -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; };
Signature · 1 line
2.34.1
Quoted 34 lines · Nihar Chaithanya
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.hencountered
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.hreported by checkpatch.pl:
WARNING: Block comments use a trailing */ on a separate lineSigned-off-by Nihar Chaithanya <[email protected]>--- include/uapi/drm/drm_mode.h | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-)include/uapi/drm/drm_mode.h +2
-1@@ -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 */
include/uapi/drm/drm_mode.h struct drm_color_lut { · line 873
Quoted 9 lines
include/uapi/drm/drm_mode.h +2
-0@@ -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; };
thanks,
-- Shuah