Skip to content

Commit 130d168

Browse files
bulwahngroeck
authored andcommitted
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>
1 parent e13e979 commit 130d168

1 file changed

Lines changed: 2 additions & 2 deletions

File tree

include/linux/hwmon.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -403,7 +403,7 @@ struct hwmon_ops {
403403
};
404404

405405
/**
406-
* Channel information
406+
* struct hwmon_channel_info - Channel information
407407
* @type: Channel type.
408408
* @config: Pointer to NULL-terminated list of channel parameters.
409409
* Use for per-channel attributes.
@@ -422,7 +422,7 @@ struct hwmon_channel_info {
422422
})
423423

424424
/**
425-
* Chip configuration
425+
* struct hwmon_chip_info - Chip configuration
426426
* @ops: Pointer to hwmon operations.
427427
* @info: Null-terminated list of channel information.
428428
*/

0 commit comments

Comments
 (0)