lkml.org 
[lkml]   [2022]   [Jun]   [9]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
Patch in this message
/
From
Subject[PATCH -next v2] HID: magicmouse: Fix some kernel-doc comments
Date
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@linux.alibaba.com>
Signed-off-by: Yang Li <yang.lee@linux.alibaba.com>
---

Change in v2:
--Improved the description of hdev.

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..07a2d5bddf8a 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, an instance of a HID device.
+ * @work: delayed work queue.
+ * @battery_timer: a dynamic timer.
*/
struct magicmouse_sc {
struct input_dev *input;
--
2.20.1.7.g153144c
\
 
 \ /
  Last update: 2022-06-10 04:29    [W:0.492 / U:0.024 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site