Skip to content

HID: uclogic: kernel-doc fixes for uclogic_params_* functions

Bagas Sanjaya linux-doc linux-input lkml llvm 1 version In review

Get series with b4
b4 am [email protected]

Versions newest first

  1. v1 Latest2 patches 1 replyIn review

Patches in v1 No applies recorded yet

#Subject and filesSizeRepliesApplied
1/2HID: uclogic: remove extraneous asterisk on uclogic_params_* static functions commentsdrivers/hid/hid-uclogic-params.c+3 -31 reply
2/2HID: uclogic: add missing function name in uclogic_params_hid_dbg() kernel-doc commentdrivers/hid/hid-uclogic-params.c+1 -10 replies

Reviews trailers per patch

No Reviewed-by, Acked-by or Tested-by trailers for v1 yet.

Read the v1 thread

Cover letter [PATCH 0/2] HID: uclogic: kernel-doc fixes for uclogic_params_* functions

Running kernel-doc script on drivers/hid/hid-uclogic-params.c found these 6 warnings below:

drivers/hid/hid-uclogic-params.c:48: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
* Dump tablet interface pen parameters with hid_dbg(), indented with one tab.
drivers/hid/hid-uclogic-params.c:48: warning: missing initial short description on line:
* Dump tablet interface pen parameters with hid_dbg(), indented with one tab.
drivers/hid/hid-uclogic-params.c:48: info: Scanning doc for function Dump
drivers/hid/hid-uclogic-params.c:80: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
* Dump tablet interface frame parameters with hid_dbg(), indented with two
drivers/hid/hid-uclogic-params.c:80: warning: missing initial short description on line:
* Dump tablet interface frame parameters with hid_dbg(), indented with two
drivers/hid/hid-uclogic-params.c:80: info: Scanning doc for function Dump
drivers/hid/hid-uclogic-params.c:105: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
* Dump tablet interface parameters with hid_dbg().
drivers/hid/hid-uclogic-params.c:105: warning: missing initial short description on line:
* Dump tablet interface parameters with hid_dbg().

One of them is reported by kernel test robot at kernel test robot at [1].

[1]: https://lore.kernel.org/linux-doc/[email protected]/

Fix these warnings by remove extraneous asterisk on static function comments on patch [1/2] and add missing function name for void function on patch [2/2].

Cc Nikolai Kondrashov <[email protected]>
Cc Jiri Kosina <[email protected]>
Cc Benjamin Tissoires <[email protected]>
Cc "José Expósito" <[email protected]>

Bagas Sanjaya (2):
HID: uclogic: remove extraneous asterisk on uclogic_params_* static
functions comments
HID: uclogic: add missing function name in uclogic_params_hid_dbg()
kernel-doc comment

 drivers/hid/hid-uclogic-params.c | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

base-commit: bf272460d744112bacd4c4d562592decbf0edf64

Signature · 1 line
An old man doll... just what I always wanted! - Clara