[PATCH v2] regulator: fix kernel-doc function parameter and warning

[PATCH v2] regulator: fix kernel-doc function parameter and warning

[Randy Dunlap]

From: Randy Dunlap <rdunlap@infradead.org>

Fix kernel-doc warning by using correct parameter description:

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

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Liam Girdwood <lgirdwood@gmail.com>
Cc: Mark Brown <broonie@kernel.org>
---
v2: add Cc:s and update patch description.

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

--- lnx-419-rc2.orig/drivers/regulator/core.c
+++ lnx-419-rc2/drivers/regulator/core.c
@@ -4470,7 +4470,7 @@ static int _regulator_suspend(struct dev
 
 /**
  * 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.
  */

Re: [PATCH v2] regulator: fix kernel-doc function parameter and warning

[Mark Brown]

[-- Attachment #1: Type: text/plain, Size: 248 bytes --]

On Mon, Sep 03, 2018 at 09:05:20AM -0700, Randy Dunlap wrote:
> From: Randy Dunlap <rdunlap@infradead.org>
> 
> Fix kernel-doc warning by using correct parameter description:

This doesn't apply against current code, please check and resend.

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 488 bytes --]