2021-12-16 09:22:15

by Lukas Bulwahn

Subject: [PATCH] HID: address kernel-doc warnings

The command ./scripts/kernel-doc -none include/linux/hid.h reports:

include/linux/hid.h:818: warning: cannot understand function prototype: 'struct hid_ll_driver '
include/linux/hid.h:1135: warning: expecting prototype for hid_may_wakeup(). Prototype was for hid_hw_may_wakeup() instead

Address those kernel-doc warnings.

Signed-off-by: Lukas Bulwahn <[email protected]>
---
include/linux/hid.h | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/include/linux/hid.h b/include/linux/hid.h
index 3d83e7022f6c..7487b0586fe6 100644
--- a/include/linux/hid.h
+++ b/include/linux/hid.h
@@ -800,7 +800,7 @@ struct hid_driver {
container_of(pdrv, struct hid_driver, driver)

/**
- * hid_ll_driver - low level driver callbacks
+ * struct hid_ll_driver - low level driver callbacks
* @start: called on probe to start the device
* @stop: called on remove
* @open: called by input layer on open
@@ -1127,7 +1127,7 @@ static inline int hid_hw_idle(struct hid_device *hdev, int report, int idle,
}

/**
- * hid_may_wakeup - return if the hid device may act as a wakeup source during system-suspend
+ * hid_hw_may_wakeup - return if the hid device may act as a wakeup source during system-suspend
*
* @hdev: hid device
*/
--
2.17.1

2022-01-06 13:21:38

by Jiri Kosina

Subject: Re: [PATCH] HID: address kernel-doc warnings

On Thu, 16 Dec 2021, Lukas Bulwahn wrote:

> The command ./scripts/kernel-doc -none include/linux/hid.h reports:
>
> include/linux/hid.h:818: warning: cannot understand function prototype: 'struct hid_ll_driver '
> include/linux/hid.h:1135: warning: expecting prototype for hid_may_wakeup(). Prototype was for hid_hw_may_wakeup() instead
>
> Address those kernel-doc warnings.
>
> Signed-off-by: Lukas Bulwahn <[email protected]>

Applied, thanks Lukas.

--
Jiri Kosina
SUSE Labs