* [PATCH] hwmon: prefix kernel-doc comments for structs with struct
@ 2021-12-16 15:42 Lukas Bulwahn
2021-12-17 15:45 ` Guenter Roeck
0 siblings, 1 reply; 2+ messages in thread
From: Lukas Bulwahn @ 2021-12-16 15:42 UTC (permalink / raw)
To: Jean Delvare, Guenter Roeck, linux-hwmon
Cc: kernel-janitors, linux-kernel, Lukas Bulwahn
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>
---
include/linux/hwmon.h | 4 ++--
1 file 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.
*/
--
2.17.1
^ permalink raw reply related [flat|nested] 2+ messages in thread
* Re: [PATCH] hwmon: prefix kernel-doc comments for structs with struct
2021-12-16 15:42 [PATCH] hwmon: prefix kernel-doc comments for structs with struct Lukas Bulwahn
@ 2021-12-17 15:45 ` Guenter Roeck
0 siblings, 0 replies; 2+ messages in thread
From: Guenter Roeck @ 2021-12-17 15:45 UTC (permalink / raw)
To: Lukas Bulwahn; +Cc: Jean Delvare, linux-hwmon, kernel-janitors, linux-kernel
On Thu, Dec 16, 2021 at 04:42:57PM +0100, Lukas Bulwahn wrote:
> 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>
Applied.
Thanks,
Guenter
> ---
> include/linux/hwmon.h | 4 ++--
> 1 file 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.
> */
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2021-12-17 15:45 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-12-16 15:42 [PATCH] hwmon: prefix kernel-doc comments for structs with struct Lukas Bulwahn
2021-12-17 15:45 ` Guenter Roeck
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.