Re: [PATCH 1/2] HID: uclogic: remove extraneous asterisk on uclogic_params_* static functions comments
From: Jonathan Corbet <corbet@lwn.net>
Date: 2022-05-29 15:03:01
Also in:
linux-doc, lkml, llvm
Bagas Sanjaya [off-list ref] writes:
*uclogic_params_pen_inrange_to_str(), uclogic_params_pen_hid_dbg(), and uclogic_params_frame_hid_dbg() are static functions but contain double-asterisk (/** */) comment, which confuses kernel-doc as public function for generating documentation. Remove the extraneous asterisk from these comments.
So there is nothing wrong with making kerneldoc comments for static functions, that is not where the problem lies.
quoted hunk ↗ jump to hunk
Link: https://lore.kernel.org/linux-doc/202205272033.XFYlYj8k-lkp@intel.com/ (local) Fixes: a228809fa6f39c ("HID: uclogic: Move param printing to a function") Reported-by: kernel test robot <redacted> Cc: Nikolai Kondrashov <redacted> Cc: Jiri Kosina <jikos@kernel.org> Cc: Benjamin Tissoires <redacted> Cc: "José Expósito" <redacted> Cc: llvm@lists.linux.dev Cc: linux-input@vger.kernel.org Cc: linux-kernel@vger.kernel.org Signed-off-by: Bagas Sanjaya <redacted> --- drivers/hid/hid-uclogic-params.c | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-)diff --git a/drivers/hid/hid-uclogic-params.c b/drivers/hid/hid-uclogic-params.c index db838f16282d64..71501453de12e4 100644 --- a/drivers/hid/hid-uclogic-params.c +++ b/drivers/hid/hid-uclogic-params.c@@ -20,7 +20,7 @@ #include <linux/ctype.h> #include <asm/unaligned.h> -/** +/* * uclogic_params_pen_inrange_to_str() - Convert a pen in-range reporting type * to a string. *
A more likely problem here is the blank between the function intro and the parameter description.
quoted hunk ↗ jump to hunk
@@ -44,7 +44,7 @@ static const char *uclogic_params_pen_inrange_to_str( } } -/** +/* * Dump tablet interface pen parameters with hid_dbg(), indented with one tab. *
Here too
quoted hunk ↗ jump to hunk
* @hdev: The HID device the pen parameters describe.@@ -76,7 +76,7 @@ static void uclogic_params_pen_hid_dbg(const struct hid_device *hdev, (pen->tilt_y_flipped ? "true" : "false")); } -/** +/* * Dump tablet interface frame parameters with hid_dbg(), indented with two * tabs. *
Here, instead, this needs to be formatted as a proper kerneldoc comment with the function name. jon