hwmon: Fix some kernel-doc comments
PATCH 1/1 hwmon: Fix some kernel-doc comments
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'
--- drivers/hwmon/aht10.c | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-)
drivers/hwmon/aht10.c +1 -2
@@ -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)
Signature · 1 line
2.20.1.7.g153144c
Quoted 10 lines · Yang Li
Make the description of @aht10_data to @data in
aht10_read_values()and remove @client inaht10_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'Reported-by Abaci Robot <[email protected]>Signed-off-by Yang Li <[email protected]>
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
Quoted 25 lines
--- drivers/hwmon/aht10.c | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-)drivers/hwmon/aht10.c +1
-2@@ -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)