Commit 98b6b62c authored Dec 16, 2021 by Yang Li Committed by Jiri Kosina Jan 06, 2022

HID: intel-ish-hid: ishtp-fw-loader: Fix a kernel-doc formatting issue



This function had kernel-doc that not used a hash to separate
the function name from the one line description.

The warning was found by running scripts/kernel-doc, which is
caused by using 'make W=1'.

drivers/hid/intel-ish-hid/ishtp-fw-loader.c:271: warning: This comment
starts with '/**', but isn't a kernel-doc comment. Refer
Documentation/doc-guide/kernel-doc.rst

Reported-by: Abaci Robot <abaci@linux.alibaba.com>
Signed-off-by: Yang Li <yang.lee@linux.alibaba.com>
Signed-off-by: Jiri Kosina <jkosina@suse.cz>

parent bcad6d1b

drivers/hid/intel-ish-hid/ishtp-fw-loader.c

+2 −1

Original line number	Diff line number	Diff line
		@@ -268,7 +268,8 @@ static int get_firmware_variant(struct ishtp_cl_data *client_data,
		}

		/**
		* loader_cl_send() Send message from host to firmware
		* loader_cl_send() - Send message from host to firmware
		*
		* @client_data: Client data instance
		* @out_msg: Message buffer to be sent to firmware
		* @out_size: Size of out going message