[PATCH -next] hwmon: Fix some kernel-doc comments

[PATCH -next] hwmon: Fix some kernel-doc comments

[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 <abaci@linux.alibaba.com>
Closes: https://bugzilla.openanolis.cn/show_bug.cgi?id=7220
Signed-off-by: Yang Li <yang.lee@linux.alibaba.com>
---
 drivers/hwmon/sht4x.c | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/drivers/hwmon/sht4x.c b/drivers/hwmon/sht4x.c
index 7ee797410458..4883755d4b1e 100644
--- a/drivers/hwmon/sht4x.c
+++ b/drivers/hwmon/sht4x.c
@@ -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)
-- 
2.20.1.7.g153144c

Re: [PATCH -next] hwmon: Fix some kernel-doc comments

[Randy Dunlap]

On 11/9/23 21:53, Yang Li wrote:
> 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 <abaci@linux.alibaba.com>
> Closes: https://bugzilla.openanolis.cn/show_bug.cgi?id=7220
> Signed-off-by: Yang Li <yang.lee@linux.alibaba.com>

Acked-by: Randy Dunlap <rdunlap@infradead.org>
Tested-by: Randy Dunlap <rdunlap@infradead.org>

Thanks.

> ---
>  drivers/hwmon/sht4x.c | 3 ++-
>  1 file changed, 2 insertions(+), 1 deletion(-)
> 
> diff --git a/drivers/hwmon/sht4x.c b/drivers/hwmon/sht4x.c
> index 7ee797410458..4883755d4b1e 100644
> --- a/drivers/hwmon/sht4x.c
> +++ b/drivers/hwmon/sht4x.c
> @@ -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)

-- 
~Randy

Re: [PATCH -next] hwmon: Fix some kernel-doc comments

[Guenter Roeck]

On Fri, Nov 10, 2023 at 01:53:41PM +0800, Yang Li wrote:
> 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 <abaci@linux.alibaba.com>
> Closes: https://bugzilla.openanolis.cn/show_bug.cgi?id=7220
> Signed-off-by: Yang Li <yang.lee@linux.alibaba.com>
> Acked-by: Randy Dunlap <rdunlap@infradead.org>
> Tested-by: Randy Dunlap <rdunlap@infradead.org>

Applied.

Thanks,
Guenter

[PATCH -next] hwmon: Fix some kernel-doc comments

[Yang Li]

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>
---
 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)
-- 
2.20.1.7.g153144c

Re: [PATCH -next] hwmon: Fix some kernel-doc comments

[Guenter Roeck]

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)