From: Nihar Chaithanya <niharchaithanya@gmail.com>
To: maarten.lankhorst@linux.intel.com
Cc: Nihar Chaithanya <niharchaithanya@gmail.com>,
skhan@linuxfoundation.org, tzimmermann@suse.de,
linux-kernel@vger.kernel.org, airlied@gmail.com, daniel@ffwll.ch,
dri-devel@lists.freedesktop.org
Subject: [PATCH] include: uapi: drm: drm_mode: fix documentation and coding style issue
Date: Thu, 22 Aug 2024 01:50:40 +0530 [thread overview]
Message-ID: <20240821202039.63516-1-niharchaithanya@gmail.com> (raw)
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@gmail.com>
---
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;
};
--
2.34.1
next reply other threads:[~2024-08-21 20:21 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-08-21 20:20 Nihar Chaithanya [this message]
2024-08-22 4:00 ` Shuah Khan
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20240821202039.63516-1-niharchaithanya@gmail.com \
--to=niharchaithanya@gmail.com \
--cc=airlied@gmail.com \
--cc=daniel@ffwll.ch \
--cc=dri-devel@lists.freedesktop.org \
--cc=linux-kernel@vger.kernel.org \
--cc=maarten.lankhorst@linux.intel.com \
--cc=skhan@linuxfoundation.org \
--cc=tzimmermann@suse.de \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox
all inboxes | Powered by JetHome®