On Thu, Jun 02, 2022 at 03:23:21PM +0700, Bagas Sanjaya wrote: > Running kernel-doc script on drivers/hid/hid-uclogic-params.c, it found > 6 warnings for hid_dbg() wrapper functions 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. > > Fix these warnings by properly format kernel-doc comment for these > functions. None of this is needed for stable kernels releases as no code is being modified. thanks, greg k-h
