hwmon: Fix some kernel-doc comments
PATCH 1/1 hwmon: Fix some kernel-doc comments
Fix some kernel-doc comments to silence the warnings:drivers/hwmon/sht4x.c:65: warning: Function parameter or member 'valid' not described in 'sht4x_data' drivers/hwmon/sht4x.c:73: warning: Function parameter or member 'data' not described in 'sht4x_read_values' drivers/hwmon/sht4x.c:73: warning: Excess function parameter 'sht4x_data' description in 'sht4x_read_values'
--- drivers/hwmon/sht4x.c | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-)
drivers/hwmon/sht4x.c +2 -1
@@ -49,6 +49,7 @@ DECLARE_CRC8_TABLE(sht4x_crc8_table);* struct sht4x_data - All the data required to operate an SHT4X chip * @client: the i2c client associated with the SHT4X * @lock: a mutex that is used to prevent parallel access to the i2c client +* @valid: validity of fields below * @update_interval: the minimum poll interval * @last_updated: the previous time that the SHT4X was polled * @temperature: the latest temperature value received from the SHT4X
@@ -66,7 +67,7 @@ struct sht4x_data {/** * sht4x_read_values() - read and parse the raw data from the SHT4X -* @sht4x_data: the struct sht4x_data to use for the lock +* @data: the struct sht4x_data to use for the lock * Return: 0 if successful, -ERRNO if not */ static int sht4x_read_values (struct sht4x_data *data)
Signature · 1 line
2.20.1.7.g153144c
Quoted 8 lines · Yang Li
Fix some kernel-doc comments to silence the warnings:
drivers/hwmon/sht4x.c:65: warning: Function parameter or member 'valid' not described in 'sht4x_data'drivers/hwmon/sht4x.c:73: warning: Function parameter or member 'data' not described in 'sht4x_read_values'drivers/hwmon/sht4x.c:73: warning: Excess function parameter 'sht4x_data' description in 'sht4x_read_values'Reported-by Abaci Robot <[email protected]>Signed-off-by Yang Li <[email protected]>
Thanks.
Quoted 25 lines
--- drivers/hwmon/sht4x.c | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-)drivers/hwmon/sht4x.c +2
-1@@ -49,6 +49,7 @@ DECLARE_CRC8_TABLE(sht4x_crc8_table);* struct sht4x_data - All the data required to operate an SHT4X chip * @client: the i2c client associated with the SHT4X * @lock: a mutex that is used to prevent parallel access to the i2c client +* @valid: validity of fields below * @update_interval: the minimum poll interval * @last_updated: the previous time that the SHT4X was polled * @temperature: the latest temperature value received from the SHT4X @@ -66,7 +67,7 @@ struct sht4x_data {/** * sht4x_read_values() - read and parse the raw data from the SHT4X -* @sht4x_data: the struct sht4x_data to use for the lock +* @data: the struct sht4x_data to use for the lock * Return: 0 if successful, -ERRNO if not */ static int sht4x_read_values (struct sht4x_data *data)
Signature · 1 line
~Randy
Quoted 10 lines · Yang Li
Fix some kernel-doc comments to silence the warnings:
drivers/hwmon/sht4x.c:65: warning: Function parameter or member 'valid' not described in 'sht4x_data'drivers/hwmon/sht4x.c:73: warning: Function parameter or member 'data' not described in 'sht4x_read_values'drivers/hwmon/sht4x.c:73: warning: Excess function parameter 'sht4x_data' description in 'sht4x_read_values'Reported-by Abaci Robot <[email protected]>Signed-off-by Yang Li <[email protected]>Acked-by Randy Dunlap <[email protected]>Tested-by Randy Dunlap <[email protected]>
Applied.
Thanks,
Guenter