Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

regulator: wm8350-regulator: Repair odd formatting in documentation

Kerneldoc expects function arguments to be in the format '@.*:'. If
this format is not followed the kerneldoc tooling/parsers/validators
get confused.

Fixes the following W=1 warning(s):

drivers/regulator/wm8350-regulator.c:1234: warning: Function parameter or member 'wm8350' not described in 'wm8350_register_led'
drivers/regulator/wm8350-regulator.c:1234: warning: Function parameter or member 'lednum' not described in 'wm8350_register_led'
drivers/regulator/wm8350-regulator.c:1234: warning: Function parameter or member 'dcdc' not described in 'wm8350_register_led'
drivers/regulator/wm8350-regulator.c:1234: warning: Function parameter or member 'isink' not described in 'wm8350_register_led'
drivers/regulator/wm8350-regulator.c:1234: warning: Function parameter or member 'pdata' not described in 'wm8350_register_led'

Signed-off-by: Lee Jones <lee.jones@linaro.org>
Link: https://lore.kernel.org/r/20200625163614.4001403-7-lee.jones@linaro.org
Signed-off-by: Mark Brown <broonie@kernel.org>

authored by

Lee Jones and committed by
Mark Brown
2f5add1e aeee55b7

+5 -5
+5 -5
drivers/regulator/wm8350-regulator.c
··· 1216 1216 /** 1217 1217 * wm8350_register_led - Register a WM8350 LED output 1218 1218 * 1219 - * @param wm8350 The WM8350 device to configure. 1220 - * @param lednum LED device index to create. 1221 - * @param dcdc The DCDC to use for the LED. 1222 - * @param isink The ISINK to use for the LED. 1223 - * @param pdata Configuration for the LED. 1219 + * @wm8350: The WM8350 device to configure. 1220 + * @lednum: LED device index to create. 1221 + * @dcdc: The DCDC to use for the LED. 1222 + * @isink: The ISINK to use for the LED. 1223 + * @pdata: Configuration for the LED. 1224 1224 * 1225 1225 * The WM8350 supports the use of an ISINK together with a DCDC to 1226 1226 * provide a power-efficient LED driver. This function registers the