HID: uclogic: properly format kernel-doc comment for hid_dbg() wrappers
Subsystems (2)
PATCH v4 1/1 HID: uclogic: properly format kernel-doc comment for hid_dbg() wrappers
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 Dumpdrivers/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 twodrivers/hid/hid-uclogic-params.c:80: warning: missing initial short description on line:
* Dump tablet interface frame parameters with hid_dbg(), indented with twodrivers/hid/hid-uclogic-params.c:80: info: Scanning doc for function Dumpdrivers/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.
---
Changes since v3 [1]:
- Drom stable ML from CC list (in response to Greg KH reply)
[1]: https://lore.kernel.org/linux-doc/[email protected]/
drivers/hid/hid-uclogic-params.c | 24 ++++++++++++++---------- 1 file changed, 14 insertions(+), 10 deletions(-)
drivers/hid/hid-uclogic-params.c +14 -10
@@ -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. */ static const char *uclogic_params_pen_inrange_to_str (enum uclogic_params_pen_inrange inrange)
@@ -45,10 +45,12 @@ static const char *uclogic_params_pen_inrange_to_str( }/** -* Dump tablet interface pen parameters with hid_dbg(), indented with one tab. -* +* uclogic_params_pen_hid_dbg() - Dump tablet interface pen parameters * @hdev: The HID device the pen parameters describe. * @pen: The pen parameters to dump. +* +* Dump tablet interface pen parameters with hid_dbg(). The dump is indented +* with a tab. */ static void uclogic_params_pen_hid_dbg (const struct hid_device *hdev,const struct uclogic_params_pen *pen)
@@ -77,11 +79,12 @@ static void uclogic_params_pen_hid_dbg(const struct hid_device *hdev, }/** -* Dump tablet interface frame parameters with hid_dbg(), indented with two -* tabs. -* +* uclogic_params_frame_hid_dbg() - Dump tablet interface frame parameters * @hdev: The HID device the pen parameters describe. * @frame: The frame parameters to dump. +* +* Dump tablet interface frame parameters with hid_dbg(). The dump is +* indented with two tabs. */ static void uclogic_params_frame_hid_dbg( const struct hid_device *hdev,
@@ -102,10 +105,11 @@ static void uclogic_params_frame_hid_dbg( }/** -* Dump tablet interface parameters with hid_dbg(). -* +* uclogic_params_hid_dbg() - Dump tablet interface parameters * @hdev: The HID device the parameters describe. * @params: The parameters to dump. +* +* Dump tablet interface parameters with hid_dbg(). */ void uclogic_params_hid_dbg (const struct hid_device *hdev,const struct uclogic_params *params)
base-commit: 1f952675835bfe18d6ae494a5581724d68c52352
Signature · 1 line
An old man doll... just what I always wanted! - Clara
Quoted 23 lines · Bagas Sanjaya
Running kernel-doc script on
drivers/hid/hid-uclogic-params.c, it found 6 warnings forhid_dbg()wrapper functions below:
drivers/hid/hid-uclogic-params.c:48: warning: This comment starts with '/**', but isn't a kernel-doc comment. ReferDocumentation/doc-guide/kernel-doc.rst
* Dump tablet interface pen parameters withhid_dbg(), indented with one tab.drivers/hid/hid-uclogic-params.c:48: warning: missing initial short description on line:
* Dump tablet interface pen parameters withhid_dbg(), indented with one tab.drivers/hid/hid-uclogic-params.c:48: info: Scanning doc for function Dumpdrivers/hid/hid-uclogic-params.c:80: warning: This comment starts with '/**', but isn't a kernel-doc comment. ReferDocumentation/doc-guide/kernel-doc.rst
* Dump tablet interface frame parameters withhid_dbg(), indented with twodrivers/hid/hid-uclogic-params.c:80: warning: missing initial short description on line:
* Dump tablet interface frame parameters withhid_dbg(), indented with twodrivers/hid/hid-uclogic-params.c:80: info: Scanning doc for function Dumpdrivers/hid/hid-uclogic-params.c:105: warning: This comment starts with '/**', but isn't a kernel-doc comment. ReferDocumentation/doc-guide/kernel-doc.rst
* Dump tablet interface parameters withhid_dbg().drivers/hid/hid-uclogic-params.c:105: warning: missing initial short description on line:
* Dump tablet interface parameters withhid_dbg().One of them is reported by kernel test robot.
Fix these warnings by properly format kernel-doc comment for these functions.
Quoted 13 lines
Fixes a228809fa6f39c ("HID: uclogic: Move param printing to a function")Reported-by kernel test robot <[email protected]>Tested-by Randy Dunlap <[email protected]>Tested-by José Expósito <[email protected]>Acked-by Randy Dunlap <[email protected]>Cc Nikolai Kondrashov <[email protected]>Cc Jiri Kosina <[email protected]>Cc Benjamin Tissoires <[email protected]>Signed-off-by Bagas Sanjaya <[email protected]>
Applied, thanks.
Signature · 2 lines
Jiri Kosina SUSE Labs