Skip to contentSkip to conversation

HID: magicmouse: Fix some kernel-doc comments

PATCH New Yang Li 1 participant 1 message Jun 10, 2022 HID

lore
Share & tools
lore

Yang Li

author
#0 lore raw

PATCH v2 1/1 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'

---

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

 drivers/hid/hid-magicmouse.c | 3 +++
 1 file changed, 3 insertions(+)
drivers/hid/hid-magicmouse.c +3 -0
index 664a624a363d..07a2d5bddf8a 100644
@@ -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;
Signature · 1 line
2.20.1.7.g153144c