[PATCH v3] regulator: fix kernel-doc for regulator_suspend()

From: Randy Dunlap
Date: Tue Sep 04 2018 - 11:30:16 EST


From: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>

Fix kernel-doc warning:

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

Signed-off-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>
Cc: Liam Girdwood <lgirdwood@xxxxxxxxx>
Cc: Mark Brown <broonie@xxxxxxxxxx>
---
v2: add missing Cc:s and update patch description.
v3: respin, v2 did not apply cleanly.

drivers/regulator/core.c | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

--- linux-next-20180904.orig/drivers/regulator/core.c
+++ linux-next-20180904/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.
*/