diff options
| author | Lukas Bulwahn <[email protected]> | 2021-12-16 16:42:57 +0100 |
|---|---|---|
| committer | Guenter Roeck <[email protected]> | 2021-12-26 15:02:06 -0800 |
| commit | 130d168866a11829b844ffdb19b9aefe384f754c (patch) | |
| tree | 468e745dfb0c1da0c4be28eb9c4d61ed969e0b96 | |
| parent | e13e979b2b3dafc9b5e7a4ec0ff17c875fedcf67 (diff) | |
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 <[email protected]>
Link: https://lore.kernel.org/r/[email protected]
Signed-off-by: Guenter Roeck <[email protected]>
| -rw-r--r-- | include/linux/hwmon.h | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/include/linux/hwmon.h b/include/linux/hwmon.h index 1e8d6ea8992e..fad1f1df26df 100644 --- 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. */ |