hwmon: prefix kernel-doc comments for structs with struct

The command ./scripts/kernel-doc -none include/linux/hwmon.h warns:

  include/linux/hwmon.h:406: warning: This comment starts with '/**', but
    isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
   * Channel information
  include/linux/hwmon.h:425: warning: This comment starts with '/**', but
    isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
   * Chip configuration

Address those kernel-doc warnings by prefixing kernel-doc descriptions for
structs with the keyword 'struct'.

Signed-off-by: Lukas Bulwahn <lukas.bulwahn@gmail.com>
Link: https://lore.kernel.org/r/20211216154257.26758-1-lukas.bulwahn@gmail.com
Signed-off-by: Guenter Roeck <linux@roeck-us.net>

diff --git a/include/linux/hwmon.h b/include/linux/hwmon.h
index 1e8d6ea..fad1f1d 100644 (file)
--- a/include/linux/hwmon.h
+++ b/include/linux/hwmon.h
@@ -403,7 +403,7 @@ struct hwmon_ops {
 };
 
 /**
- * Channel information
+ * struct hwmon_channel_info - Channel information
  * @type:      Channel type.
  * @config:    Pointer to NULL-terminated list of channel parameters.
  *             Use for per-channel attributes.
@@ -422,7 +422,7 @@ struct hwmon_channel_info {
        })
 
 /**
- * Chip configuration
+ * struct hwmon_chip_info - Chip configuration
  * @ops:       Pointer to hwmon operations.
  * @info:      Null-terminated list of channel information.
  */