PM/sleep: fix doc warnings in main.c
Subsystems (2)
PATCH 1/1 PM/sleep: fix doc warnings in main.c
Add description for state_show to fix the W=1 warnings:
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'
--- kernel/power/main.c | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-)
kernel/power/main.c +3 -1
@@ -579,7 +579,9 @@ struct kobject *power_kobj;/** * state - control system sleep states. -* +* @kobj: Pointer to the kernel object. +* @attr: Pointer to the kernel object attribute. +* @buf: buffer. * show() returns available sleep state labels, which may be "mem", "standby", * "freeze" and "disk" (hibernation). * See Documentation/admin-guide/pm/sleep-states.rst for a description of
Signature · 1 line
2.31.1
Rafael J. Wysocki
maintainerQuoted 20 lines · Baokun Li
Add description for
state_showto fix the W=1 warnings:
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 Baokun Li <[email protected]>--- kernel/power/main.c | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-)kernel/power/main.c +0
-0
kernel/power/main.c struct kobject *power_kobj; · line 584
Quoted 7 lines
kernel/power/main.c +3
-1@@ -579,7 +579,9 @@ struct kobject *power_kobj;/** * state - control system sleep states. -* +* @kobj: Pointer to the kernel object. +* @attr: Pointer to the kernel object attribute. +* @buf: buffer.
Please fix this properly or don't touch it.
This is not a kerneldoc comment of a function and so adding argument descriptions to it is pointless.
Quoted 6 lines
kernel/power/main.c +0
-1* show() returns available sleep state labels, which may be "mem", "standby", * "freeze" and "disk" (hibernation). * See Documentation/admin-guide/pm/sleep-states.rst for a description of -- 2.31.1