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

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [thread-next>] [day] [month] [year] [list]

Message-Id: <20220602075821.49622-1-yang.lee@linux.alibaba.com>
Date:   Thu,  2 Jun 2022 15:58:21 +0800
From:   Yang Li <yang.lee@...ux.alibaba.com>
To:     jikos@...nel.org
Cc:     benjamin.tissoires@...hat.com, linux-input@...r.kernel.org,
        linux-kernel@...r.kernel.org, Yang Li <yang.lee@...ux.alibaba.com>,
        Abaci Robot <abaci@...ux.alibaba.com>
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 <abaci@...ux.alibaba.com>
Signed-off-by: Yang Li <yang.lee@...ux.alibaba.com>
---
 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