2022-06-02 09:43:10

by Yang Li

Subject: [PATCH -next] HID: magicmouse: Fix some kernel-doc comments

Remove warnings found by running scripts/kernel-doc,
which is caused by using 'make W=1'.
drivers/hid/hid-magicmouse.c:148: warning: Function parameter or member
'hdev' not described in 'magicmouse_sc'
drivers/hid/hid-magicmouse.c:148: warning: Function parameter or member
'work' not described in 'magicmouse_sc'
drivers/hid/hid-magicmouse.c:148: warning: Function parameter or member
'battery_timer' not described in 'magicmouse_sc'

Reported-by: Abaci Robot <[email protected]>
Signed-off-by: Yang Li <[email protected]>
---
drivers/hid/hid-magicmouse.c | 3 +++
1 file changed, 3 insertions(+)

diff --git a/drivers/hid/hid-magicmouse.c b/drivers/hid/hid-magicmouse.c
index 664a624a363d..a13e07397e5d 100644
--- a/drivers/hid/hid-magicmouse.c
+++ b/drivers/hid/hid-magicmouse.c
@@ -120,6 +120,9 @@ MODULE_PARM_DESC(report_undeciphered, "Report undeciphered multi-touch state fie
* @scroll_jiffies: Time of last scroll motion.
* @touches: Most recent data for a touch, indexed by tracking ID.
* @tracking_ids: Mapping of current touch input data to @touches.
+ * @hdev: device report descriptor
+ * @work: delayed work queue
+ * @battery_timer: a dynamic timer
*/
struct magicmouse_sc {
struct input_dev *input;
--
2.20.1.7.g153144c

2022-06-09 10:15:40

by Jiri Kosina

Subject: Re: [PATCH -next] HID: magicmouse: Fix some kernel-doc comments

On Thu, 2 Jun 2022, Yang Li wrote:

> Remove warnings found by running scripts/kernel-doc,
> which is caused by using 'make W=1'.
> drivers/hid/hid-magicmouse.c:148: warning: Function parameter or member
> 'hdev' not described in 'magicmouse_sc'
> drivers/hid/hid-magicmouse.c:148: warning: Function parameter or member
> 'work' not described in 'magicmouse_sc'
> drivers/hid/hid-magicmouse.c:148: warning: Function parameter or member
> 'battery_timer' not described in 'magicmouse_sc'
>
> Reported-by: Abaci Robot <[email protected]>
> Signed-off-by: Yang Li <[email protected]>
> ---
> drivers/hid/hid-magicmouse.c | 3 +++
> 1 file changed, 3 insertions(+)
>
> diff --git a/drivers/hid/hid-magicmouse.c b/drivers/hid/hid-magicmouse.c
> index 664a624a363d..a13e07397e5d 100644
> --- a/drivers/hid/hid-magicmouse.c
> +++ b/drivers/hid/hid-magicmouse.c
> @@ -120,6 +120,9 @@ MODULE_PARM_DESC(report_undeciphered, "Report undeciphered multi-touch state fie
> * @scroll_jiffies: Time of last scroll motion.
> * @touches: Most recent data for a touch, indexed by tracking ID.
> * @tracking_ids: Mapping of current touch input data to @touches.
> + * @hdev: device report descriptor

This is not a correct desciption; struct hid_device is much more than
report descriptor. Could you please fix that up and resend?

Thanks,

--
Jiri Kosina
SUSE Labs