Commit d5e649a5 authored Jun 04, 2022 by Bagas Sanjaya Committed by Jiri Kosina Jun 08, 2022

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 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@intel.com/


Fixes: a228809f ("HID: uclogic: Move param printing to a function")
Reported-by: kernel test robot <lkp@intel.com>
Tested-by: Randy Dunlap <rdunlap@infradead.org>
Tested-by: José Expósito <jose.exposito89@gmail.com>
Acked-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Nikolai Kondrashov <spbnick@gmail.com>
Cc: Jiri Kosina <jikos@kernel.org>
Cc: Benjamin Tissoires <benjamin.tissoires@redhat.com>
Cc: llvm@lists.linux.dev
Cc: linux-input@vger.kernel.org
Cc: linux-kernel@vger.kernel.org
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
Signed-off-by: Jiri Kosina <jkosina@suse.cz>

parent 92cdfba4

drivers/hid/hid-uclogic-params.c

+14 −10

Original line number	Diff line number	Diff line
		@@ -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)