hwmon: prefix kernel-doc comments for structs with struct
Subsystems (2)
PATCH 1/1 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'.
--- include/linux/hwmon.h | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)
include/linux/hwmon.h +2 -2
@@ -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. */
Signature · 1 line
2.17.1
Quoted 9 lines · Lukas Bulwahn
The command
./scripts/kernel-doc-noneinclude/linux/hwmon.hwarns:
include/linux/hwmon.h:406: warning: This comment starts with '/**', but
isn't a kernel-doc comment. ReferDocumentation/doc-guide/kernel-doc.rst
* Channel information
include/linux/hwmon.h:425: warning: This comment starts with '/**', but
isn't a kernel-doc comment. ReferDocumentation/doc-guide/kernel-doc.rst
* Chip configuration
Quoted 4 lines
Address those kernel-doc warnings by prefixing kernel-doc descriptions for structs with the keyword 'struct'.
Signed-off-by Lukas Bulwahn <[email protected]>
Applied.
Thanks,
Guenter
Quoted 26 lines
--- include/linux/hwmon.h | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)include/linux/hwmon.h +2
-2@@ -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. */