PM / suspend: fix kernel-doc markup

Alex Shi · rafaeljw · commit ab150c3f80dc · 2020-11-23T18:24:53.000+01:00
Add parameter explanation to fix kernel-doc marks:

kernel/power/suspend.c:233: warning: Function parameter or member
'state' not described in 'suspend_valid_only_mem'
kernel/power/suspend.c:344: warning: Function parameter or member
'state' not described in 'suspend_prepare'

Signed-off-by: Alex Shi &lt;alex.shi@linux.alibaba.com&gt;
[ rjw: Change the proposed parameter descriptions. ]
Signed-off-by: Rafael J. Wysocki &lt;rafael.j.wysocki@intel.com&gt;
diff --git a/kernel/power/suspend.c b/kernel/power/suspend.c
@@ -224,6 +224,7 @@ EXPORT_SYMBOL_GPL(suspend_set_ops);
 
 /**
  * suspend_valid_only_mem - Generic memory-only valid callback.
+ * @state: Target system sleep state.
  *
  * Platform drivers that implement mem suspend only and only need to check for
  * that in their .valid() callback can use this instead of rolling their own
@@ -335,6 +336,7 @@ static int suspend_test(int level)
 
 /**
  * suspend_prepare - Prepare for entering system sleep state.
+ * @state: Target system sleep state.
  *
  * Common code run for every system sleep state that can be entered (except for
  * hibernation).  Run suspend notifiers, allocate the "suspend" console and

Original file line number	Diff line number	Diff line change
`@@ -224,6 +224,7 @@ EXPORT_SYMBOL_GPL(suspend_set_ops);`
`224`	`224`
`225`	`225`	`/**`
`226`	`226`	`* suspend_valid_only_mem - Generic memory-only valid callback.`
	`227`	`+ * @state: Target system sleep state.`
`227`	`228`	`*`
`228`	`229`	`* Platform drivers that implement mem suspend only and only need to check for`
`229`	`230`	`* that in their .valid() callback can use this instead of rolling their own`
`@@ -335,6 +336,7 @@ static int suspend_test(int level)`
`335`	`336`
`336`	`337`	`/**`
`337`	`338`	`* suspend_prepare - Prepare for entering system sleep state.`
	`339`	`+ * @state: Target system sleep state.`
`338`	`340`	`*`
`339`	`341`	`* Common code run for every system sleep state that can be entered (except for`
`340`	`342`	`* hibernation). Run suspend notifiers, allocate the "suspend" console and`