diff mbox series

hwmon: (emc2305) fix kernel-doc warnings

Message ID 20230113064540.20179-1-rdunlap@infradead.org
State New
Headers
Series hwmon: (emc2305) fix kernel-doc warnings |

Commit Message

Randy Dunlap Jan. 13, 2023, 6:45 a.m. UTC 
  Fix kernel-doc warnings:
drivers/hwmon/emc2305.c:62: warning: Cannot understand  * @cdev: cooling device;
 on line 62 - I thought it was a doc line
drivers/hwmon/emc2305.c:89: warning: Cannot understand  * @client: i2c client;
 on line 89 - I thought it was a doc line

and drop ';' at end of each struct member line.

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Jean Delvare <jdelvare@suse.com>
Cc: Guenter Roeck <linux@roeck-us.net>
Cc: linux-hwmon@vger.kernel.org
---
 drivers/hwmon/emc2305.c |   24 +++++++++++++-----------
 1 file changed, 13 insertions(+), 11 deletions(-)

Comments

Guenter Roeck Jan. 15, 2023, 4:02 p.m. UTC | #1 
On Thu, Jan 12, 2023 at 10:45:40PM -0800, Randy Dunlap wrote:
> Fix kernel-doc warnings:
> drivers/hwmon/emc2305.c:62: warning: Cannot understand  * @cdev: cooling device;
>  on line 62 - I thought it was a doc line
> drivers/hwmon/emc2305.c:89: warning: Cannot understand  * @client: i2c client;
>  on line 89 - I thought it was a doc line
> 
> and drop ';' at end of each struct member line.
> 
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> Cc: Jean Delvare <jdelvare@suse.com>
> Cc: Guenter Roeck <linux@roeck-us.net>
> Cc: linux-hwmon@vger.kernel.org

Applied to hwmon-next.

Thanks,
Guenter
diff mbox series

Patch

diff -- a/drivers/hwmon/emc2305.c b/drivers/hwmon/emc2305.c
--- a/drivers/hwmon/emc2305.c
+++ b/drivers/hwmon/emc2305.c
@@ -59,10 +59,11 @@  static const struct i2c_device_id emc230
 MODULE_DEVICE_TABLE(i2c, emc2305_ids);
 
 /**
- * @cdev: cooling device;
- * @curr_state: cooling current state;
- * @last_hwmon_state: last cooling state updated by hwmon subsystem;
- * @last_thermal_state: last cooling state updated by thermal subsystem;
+ * struct emc2305_cdev_data - device-specific cooling device state
+ * @cdev: cooling device
+ * @cur_state: cooling current state
+ * @last_hwmon_state: last cooling state updated by hwmon subsystem
+ * @last_thermal_state: last cooling state updated by thermal subsystem
  *
  * The 'last_hwmon_state' and 'last_thermal_state' fields are provided to support fan low limit
  * speed feature. The purpose of this feature is to provides ability to limit fan speed
@@ -86,13 +87,14 @@  struct emc2305_cdev_data {
 };
 
 /**
- * @client: i2c client;
- * @hwmon_dev: hwmon device;
- * @max_state: maximum cooling state of the cooling device;
- * @pwm_num: number of PWM channels;
- * @pwm_separate: separate PWM settings for every channel;
- * @pwm_min: array of minimum PWM per channel;
- * @cdev_data: array of cooling devices data;
+ * struct emc2305_data - device-specific data
+ * @client: i2c client
+ * @hwmon_dev: hwmon device
+ * @max_state: maximum cooling state of the cooling device
+ * @pwm_num: number of PWM channels
+ * @pwm_separate: separate PWM settings for every channel
+ * @pwm_min: array of minimum PWM per channel
+ * @cdev_data: array of cooling devices data
  */
 struct emc2305_data {
 	struct i2c_client *client;