lkml.org 
[lkml]   [2021]   [Dec]   [17]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
Date
From
SubjectRe: [PATCH] hwmon: prefix kernel-doc comments for structs with struct
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.
> */

\
 
 \ /
  Last update: 2021-12-17 16:45    [W:0.035 / U:28.172 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site