[PATCH] kernel/power: unmark 'state' functions as kernel-doc

[PATCH] kernel/power: unmark 'state' functions as kernel-doc

[Randy Dunlap]

Fix kernel-doc warnings in kernel/power/main.c by unmarking the
comment block as kernel-doc notation. This eliminates the following
kernel-doc warnings:

kernel/power/main.c:593: warning: expecting prototype for state(). Prototype was for state_show() instead
kernel/power/main.c:593: warning: Function parameter or member 'kobj' not described in 'state_show'
kernel/power/main.c:593: warning: Function parameter or member 'attr' not described in 'state_show'
kernel/power/main.c:593: warning: Function parameter or member 'buf' not described in 'state_show'

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: "Rafael J. Wysocki" <rjw@rjwysocki.net>
Cc: Pavel Machek <pavel@ucw.cz>
Cc: Len Brown <len.brown@intel.com>
Cc: linux-pm@vger.kernel.org
---
 kernel/power/main.c |    2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

--- linux-next-20210809.orig/kernel/power/main.c
+++ linux-next-20210809/kernel/power/main.c
@@ -577,7 +577,7 @@ static inline void pm_print_times_init(v
 
 struct kobject *power_kobj;
 
-/**
+/*
  * state - control system sleep states.
  *
  * show() returns available sleep state labels, which may be "mem", "standby",

Re: [PATCH] kernel/power: unmark 'state' functions as kernel-doc

[Rafael J. Wysocki]

On Tue, Aug 10, 2021 at 3:44 AM Randy Dunlap <rdunlap@infradead.org> wrote:
>
> Fix kernel-doc warnings in kernel/power/main.c by unmarking the
> comment block as kernel-doc notation. This eliminates the following
> kernel-doc warnings:
>
> kernel/power/main.c:593: warning: expecting prototype for state(). Prototype was for state_show() instead
> kernel/power/main.c:593: warning: Function parameter or member 'kobj' not described in 'state_show'
> kernel/power/main.c:593: warning: Function parameter or member 'attr' not described in 'state_show'
> kernel/power/main.c:593: warning: Function parameter or member 'buf' not described in 'state_show'
>
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> Cc: "Rafael J. Wysocki" <rjw@rjwysocki.net>
> Cc: Pavel Machek <pavel@ucw.cz>
> Cc: Len Brown <len.brown@intel.com>
> Cc: linux-pm@vger.kernel.org
> ---
>  kernel/power/main.c |    2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> --- linux-next-20210809.orig/kernel/power/main.c
> +++ linux-next-20210809/kernel/power/main.c
> @@ -577,7 +577,7 @@ static inline void pm_print_times_init(v
>
>  struct kobject *power_kobj;
>
> -/**
> +/*
>   * state - control system sleep states.
>   *
>   * show() returns available sleep state labels, which may be "mem", "standby",

Applied as 5.15 material, thanks!