On 5/31/22 02:28, 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. > > Link: https://lore.kernel.org/linux-doc/202205272033.XFYlYj8k-lkp@xxxxxxxxx/ > Fixes: a228809fa6f39c ("HID: uclogic: Move param printing to a function") > Reported-by: kernel test robot <lkp@xxxxxxxxx> > Cc: Nikolai Kondrashov <spbnick@xxxxxxxxx> > Cc: Jiri Kosina <jikos@xxxxxxxxxx> > Cc: Benjamin Tissoires <benjamin.tissoires@xxxxxxxxxx> > Cc: "José Expósito" <jose.exposito89@xxxxxxxxx> > Cc: llvm@xxxxxxxxxxxxxxx > Cc: stable@xxxxxxxxxxxxxxx # v5.18 > Cc: linux-input@xxxxxxxxxxxxxxx > Cc: linux-kernel@xxxxxxxxxxxxxxx > Signed-off-by: Bagas Sanjaya <bagasdotme@xxxxxxxxx> > --- > Changes since v1 [1]: > - Approach the warning by fixing kernel-doc comments formatting > (suggested by Jonathan Corbet) > > [1]: https://lore.kernel.org/linux-doc/20220528091403.160169-1-bagasdotme@xxxxxxxxx/ Tested-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx> Acked-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx> One note (nit) below: > drivers/hid/hid-uclogic-params.c | 24 ++++++++++++++---------- > 1 file changed, 14 insertions(+), 10 deletions(-) > > diff --git a/drivers/hid/hid-uclogic-params.c b/drivers/hid/hid-uclogic-params.c > index db838f16282d64..647bbd3e000e2f 100644 > --- a/drivers/hid/hid-uclogic-params.c > +++ b/drivers/hid/hid-uclogic-params.c > @@ -23,11 +23,11 @@ > /** > * uclogic_params_pen_inrange_to_str() - Convert a pen in-range reporting type > * to a string. > - * > * @inrange: The in-range reporting type to convert. > * > - * Returns: > - * The string representing the type, or NULL if the type is unknown. > + * Return: > + * * The string representing the type, or > + * * NULL if the type is unknown. %NULL would be better here, but not required. > */ > static const char *uclogic_params_pen_inrange_to_str( > enum uclogic_params_pen_inrange inrange) Thanks. -- ~Randy
