diff mbox series

[09/10] mfd: wm8400-core: Supply description for wm8400_reset_codec_reg_cache's arg

Message ID 20200624150704.2729736-10-lee.jones@linaro.org
State New
Headers show
Series [01/10] mfd: twl4030-irq: Fix incorrect type in assignment warning | expand

Commit Message

Lee Jones June 24, 2020, 3:07 p.m. UTC 
Kerneldoc syntax is used, but not complete.  Descriptions required.

Prevents warnings like:

 drivers/mfd/wm8400-core.c:113: warning: Function parameter or member 'wm8400' not described in 'wm8400_reset_codec_reg_cache'

Cc: <stable@vger.kernel.org>
Cc: Mark Brown <broonie@opensource.wolfsonmicro.com>
Cc: patches@opensource.cirrus.com
Signed-off-by: Lee Jones <lee.jones@linaro.org>

---
 drivers/mfd/wm8400-core.c | 2 ++
 1 file changed, 2 insertions(+)

-- 
2.25.1

Comments

Charles Keepax June 24, 2020, 4:24 p.m. UTC | #1 
On Wed, Jun 24, 2020 at 04:07:03PM +0100, Lee Jones wrote:
> Kerneldoc syntax is used, but not complete.  Descriptions required.

> 

> Prevents warnings like:

> 

>  drivers/mfd/wm8400-core.c:113: warning: Function parameter or member 'wm8400' not described in 'wm8400_reset_codec_reg_cache'

> 

> Cc: <stable@vger.kernel.org>

> Cc: Mark Brown <broonie@opensource.wolfsonmicro.com>

> Cc: patches@opensource.cirrus.com

> Signed-off-by: Lee Jones <lee.jones@linaro.org>

> ---


Acked-by: Charles Keepax <ckeepax@opensource.cirrus.com>


Thanks,
Charles
diff mbox series

Patch

diff --git a/drivers/mfd/wm8400-core.c b/drivers/mfd/wm8400-core.c
index 3055d6f47afcc..0fe32a05421be 100644
--- a/drivers/mfd/wm8400-core.c
+++ b/drivers/mfd/wm8400-core.c
@@ -108,6 +108,8 @@  static const struct regmap_config wm8400_regmap_config = {
 /**
  * wm8400_reset_codec_reg_cache - Reset cached codec registers to
  * their default values.
+ *
+ * @wm8400: pointer to local driver data structure
  */
 void wm8400_reset_codec_reg_cache(struct wm8400 *wm8400)
 {