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

From: Jiri Kosina
Date: Wed Sep 23 2020 - 07:11:36 EST


On Tue, 22 Sep 2020, Xiaofei Tan wrote:

> Fix following warnings caused by mismatch bewteen function parameters
> and comments.
> drivers/hid/i2c-hid/i2c-hid-core.c:331: warning: Function parameter or member 'data_len' not described in 'i2c_hid_set_or_send_report'
> drivers/hid/i2c-hid/i2c-hid-core.c:331: warning: Excess function parameter 'len' description in 'i2c_hid_set_or_send_report'
>
> Signed-off-by: Xiaofei Tan <tanxiaofei@xxxxxxxxxx>
> ---
> drivers/hid/i2c-hid/i2c-hid-core.c | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/drivers/hid/i2c-hid/i2c-hid-core.c b/drivers/hid/i2c-hid/i2c-hid-core.c
> index dbd0449..01e9b36 100644
> --- a/drivers/hid/i2c-hid/i2c-hid-core.c
> +++ b/drivers/hid/i2c-hid/i2c-hid-core.c
> @@ -323,7 +323,7 @@ static int i2c_hid_get_report(struct i2c_client *client, u8 reportType,
> * @reportType: 0x03 for HID_FEATURE_REPORT ; 0x02 for HID_OUTPUT_REPORT
> * @reportID: the report ID
> * @buf: the actual data to transfer, without the report ID
> - * @len: size of buf
> + * @data_len: size of buf
> * @use_data: true: use SET_REPORT HID command, false: send plain OUTPUT report

Applied.

--
Jiri Kosina
SUSE Labs