[prev in list] [next in list] [prev in thread] [next in thread] 

List:       linux-hwmon
Subject:    Re: [PATCH -next] hwmon: Fix some kernel-doc comments
From:       Guenter Roeck <linux () roeck-us ! net>
Date:       2022-12-29 14:48:48
Message-ID: 20221229144848.GA21999 () roeck-us ! net
[Download RAW message or body]

On Fri, Dec 23, 2022 at 04:10:56PM +0800, Yang Li wrote:
> Make the description of @aht10_data to @data in aht10_read_values()
> and remove @client in aht10_init() to clear the below warnings:
> 
> drivers/hwmon/aht10.c:87: warning: Excess function parameter 'client' description \
> in 'aht10_init' drivers/hwmon/aht10.c:131: warning: Function parameter or member \
> 'data' not described in 'aht10_read_values' drivers/hwmon/aht10.c:131: warning: \
> Excess function parameter 'aht10_data' description in 'aht10_read_values' 
> Link: https://bugzilla.openanolis.cn/show_bug.cgi?id=3543
> Reported-by: Abaci Robot <abaci@linux.alibaba.com>
> Signed-off-by: Yang Li <yang.lee@linux.alibaba.com>

This onlyt affects a single driver, which should be mentioned in the
subject. No need to resend - I'll fix it up -
but please keep it in mind for future patches.

Applied to hwmon-next.

Thanks,
Guenter

> ---
> drivers/hwmon/aht10.c | 3 +--
> 1 file changed, 1 insertion(+), 2 deletions(-)
> 
> diff --git a/drivers/hwmon/aht10.c b/drivers/hwmon/aht10.c
> index d76f3441ecf1..9babd69d54a3 100644
> --- a/drivers/hwmon/aht10.c
> +++ b/drivers/hwmon/aht10.c
> @@ -79,7 +79,6 @@ struct aht10_data {
> 
> /**
> * aht10_init() - Initialize an AHT10 chip
> - * @client: the i2c client associated with the AHT10
> * @data: the data associated with this AHT10 chip
> * Return: 0 if succesfull, 1 if not
> */
> @@ -124,7 +123,7 @@ static int aht10_polltime_expired(struct aht10_data *data)
> 
> /**
> * aht10_read_values() - read and parse the raw data from the AHT10
> - * @aht10_data: the struct aht10_data to use for the lock
> + * @data: the struct aht10_data to use for the lock
> * Return: 0 if succesfull, 1 if not
> */
> static int aht10_read_values(struct aht10_data *data)


[prev in list] [next in list] [prev in thread] [next in thread]