regulator: fix kernel-doc for regulator_suspend()

rddunlap · broonie · commit 1efef7cc7271 · 2018-09-04T16:57:23.000+01:00
Fix kernel-doc warning:

../drivers/regulator/core.c:4479: warning: Excess function parameter 'state' description in 'regulator_suspend'

Signed-off-by: Randy Dunlap &lt;rdunlap@infradead.org&gt;
Cc: Liam Girdwood &lt;lgirdwood@gmail.com&gt;
Cc: Mark Brown &lt;broonie@kernel.org&gt;
Signed-off-by: Mark Brown &lt;broonie@kernel.org&gt;
diff --git a/drivers/regulator/core.c b/drivers/regulator/core.c
@@ -4466,7 +4466,7 @@ EXPORT_SYMBOL_GPL(regulator_unregister);
 #ifdef CONFIG_SUSPEND
 /**
  * regulator_suspend - prepare regulators for system wide suspend
- * @state: system suspend state
+ * @dev: ``&struct device`` pointer that is passed to _regulator_suspend()
  *
  * Configure each regulator with it's suspend operating parameters for state.
  */

Original file line number	Diff line number	Diff line change
`@@ -4466,7 +4466,7 @@ EXPORT_SYMBOL_GPL(regulator_unregister);`
`4466`	`4466`	`#ifdef CONFIG_SUSPEND`
`4467`	`4467`	`/**`
`4468`	`4468`	`* regulator_suspend - prepare regulators for system wide suspend`
`4469`		`- * @state: system suspend state`
	`4469`	+ * @dev: ``&struct device`` pointer that is passed to _regulator_suspend()
`4470`	`4470`	`*`
`4471`	`4471`	`* Configure each regulator with it's suspend operating parameters for state.`
`4472`	`4472`	`*/`