2020-09-22 12:05:44

by Xiaofei Tan

Subject: [PATCH] HID: core: fix some doc warnings in hid-core.c

Fix following warnings caused by mismatch bewteen function parameters
and comments.
drivers/hid/hid-core.c:931: warning: Function parameter or member 'hid' not described in 'hid_parse_report'
drivers/hid/hid-core.c:931: warning: Excess function parameter 'device' description in 'hid_parse_report'
drivers/hid/hid-core.c:961: warning: Function parameter or member 'hid' not described in 'hid_validate_values'
drivers/hid/hid-core.c:961: warning: Excess function parameter 'device' description in 'hid_validate_values'
drivers/hid/hid-core.c:1452: warning: Function parameter or member 'report' not described in 'hid_match_report'
drivers/hid/hid-core.c:1452: warning: Excess function parameter 'report_type' description in 'hid_match_report'
drivers/hid/hid-core.c:2132: warning: Function parameter or member 'drv' not described in 'new_id_store'
drivers/hid/hid-core.c:2132: warning: Excess function parameter 'driver' description in 'new_id_store'

Signed-off-by: Xiaofei Tan <[email protected]>
---
drivers/hid/hid-core.c | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/drivers/hid/hid-core.c b/drivers/hid/hid-core.c
index d2ecc9c..727d042 100644
--- a/drivers/hid/hid-core.c
+++ b/drivers/hid/hid-core.c
@@ -920,7 +920,7 @@ static int hid_scan_report(struct hid_device *hid)
/**
* hid_parse_report - parse device report
*
- * @device: hid device
+ * @hid: hid device
* @start: report start
* @size: report size
*
@@ -945,7 +945,7 @@ static const char * const hid_report_names[] = {
/**
* hid_validate_values - validate existing device report's value indexes
*
- * @device: hid device
+ * @hid: hid device
* @type: which report type to examine
* @id: which report ID to examine (0 for first)
* @field_index: which report field to examine
@@ -1444,7 +1444,7 @@ static int search(__s32 *array, __s32 value, unsigned n)
* hid_match_report - check if driver's raw_event should be called
*
* @hid: hid device
- * @report_type: type to match against
+ * @report: hid report to match against
*
* compare hid->driver->report_table->report_type to report->type
*/
@@ -2120,7 +2120,7 @@ struct hid_dynid {

/**
* store_new_id - add a new HID device ID to this driver and re-probe devices
- * @driver: target device driver
+ * @drv: target device driver
* @buf: buffer for scanning device ID data
* @count: input size
*
--
2.8.1

2020-09-23 11:12:58

by Jiri Kosina

Subject: Re: [PATCH] HID: core: fix some doc warnings in hid-core.c

On Tue, 22 Sep 2020, Xiaofei Tan wrote:

> Fix following warnings caused by mismatch bewteen function parameters
> and comments.
> drivers/hid/hid-core.c:931: warning: Function parameter or member 'hid' not described in 'hid_parse_report'
> drivers/hid/hid-core.c:931: warning: Excess function parameter 'device' description in 'hid_parse_report'
> drivers/hid/hid-core.c:961: warning: Function parameter or member 'hid' not described in 'hid_validate_values'
> drivers/hid/hid-core.c:961: warning: Excess function parameter 'device' description in 'hid_validate_values'
> drivers/hid/hid-core.c:1452: warning: Function parameter or member 'report' not described in 'hid_match_report'
> drivers/hid/hid-core.c:1452: warning: Excess function parameter 'report_type' description in 'hid_match_report'
> drivers/hid/hid-core.c:2132: warning: Function parameter or member 'drv' not described in 'new_id_store'
> drivers/hid/hid-core.c:2132: warning: Excess function parameter 'driver' description in 'new_id_store'
>
> Signed-off-by: Xiaofei Tan <[email protected]>

Applied, thanks.

--
Jiri Kosina
SUSE Labs