Linux Input/HID development
 help / color / mirror / Atom feed
From: hanzhijian <hanzhijian1991@gmail.com>
To: Hans de Goede <hansg@kernel.org>, Jiri Kosina <jikos@kernel.org>,
	Benjamin Tissoires <bentiss@kernel.org>
Cc: linux-input@vger.kernel.org, linux-kernel@vger.kernel.org,
	hanzhijian <hanzhijian1991@gmail.com>
Subject: [PATCH] HID: lg-g15: fix kernel-doc comment for TEST_BIT
Date: Sat, 22 Aug 2026 07:37:31 +0800	[thread overview]
Message-ID: <20260821233731.2331171-1-hanzhijian1991@gmail.com> (raw)

The comment for the TEST_BIT() macro starts with "/**" but lacks the
macro name line, so scripts/kernel-doc reports "isn't a kernel-doc
comment" and it is silently dropped from the generated documentation.

Add the missing name line.

Signed-off-by: hanzhijian <hanzhijian1991@gmail.com>
---
 drivers/hid/hid-lg-g15.c | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/drivers/hid/hid-lg-g15.c b/drivers/hid/hid-lg-g15.c
index 02ef3e209..c22820243 100644
--- a/drivers/hid/hid-lg-g15.c
+++ b/drivers/hid/hid-lg-g15.c
@@ -35,7 +35,10 @@
 #define LG_G13_BACKLIGHT_HW_ON_BIT	23
 
 /**
- * g13_input_report.keybits[] is not 32-bit aligned, so we can't use the bitops macros.
+ * TEST_BIT() - Test a bit in an unaligned byte array
+ *
+ * g13_input_report.keybits[] is not 32-bit aligned, so we cannot use
+ * the bitops macros.
  *
  * @ary: Pointer to array of u8s
  * @b: Bit index into ary, LSB first.  Not range checked.
-- 
2.43.0


                 reply	other threads:[~2026-08-21 23:37 UTC|newest]

Thread overview: [no followups] expand[flat|nested]  mbox.gz  Atom feed

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=20260821233731.2331171-1-hanzhijian1991@gmail.com \
    --to=hanzhijian1991@gmail.com \
    --cc=bentiss@kernel.org \
    --cc=hansg@kernel.org \
    --cc=jikos@kernel.org \
    --cc=linux-input@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    /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