2020-06-26 07:14:48

by Lee Jones

Subject: [PATCH 8/9] regulator: wm8400-regulator: Repair dodgy kerneldoc header formatting

W=1 kernel builds report a lack of descriptions for various
function arguments. In reality they are documented, but the
formatting was not as expected '@.*:'. Instead, some weird
arg identifiers were used.

This change fixes the following warnings:

drivers/regulator/wm8400-regulator.c:243: warning: Function parameter or member 'dev' not described in 'wm8400_register_regulator'
drivers/regulator/wm8400-regulator.c:243: warning: Function parameter or member 'reg' not described in 'wm8400_register_regulator'
drivers/regulator/wm8400-regulator.c:243: warning: Function parameter or member 'initdata' not described in 'wm8400_register_regulator'

Cc: [email protected]
Signed-off-by: Lee Jones <[email protected]>
---
drivers/regulator/wm8400-regulator.c | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/drivers/regulator/wm8400-regulator.c b/drivers/regulator/wm8400-regulator.c
index 4cb1fbb597227..e9fd137077213 100644
--- a/drivers/regulator/wm8400-regulator.c
+++ b/drivers/regulator/wm8400-regulator.c
@@ -234,9 +234,9 @@ static struct platform_driver wm8400_regulator_driver = {
* the regulator API. It is intended to be called from the
* platform_init() callback of the WM8400 MFD driver.
*
- * @param dev The WM8400 device to operate on.
- * @param reg The regulator to control.
- * @param initdata Regulator initdata for the regulator.
+ * @dev: The WM8400 device to operate on.
+ * @reg: The regulator to control.
+ * @initdata: Regulator initdata for the regulator.
*/
int wm8400_register_regulator(struct device *dev, int reg,
struct regulator_init_data *initdata)
--
2.25.1

2020-06-26 09:21:23

by Charles Keepax

Subject: Re: [PATCH 8/9] regulator: wm8400-regulator: Repair dodgy kerneldoc header formatting

On Fri, Jun 26, 2020 at 07:57:37AM +0100, Lee Jones wrote:
> W=1 kernel builds report a lack of descriptions for various
> function arguments. In reality they are documented, but the
> formatting was not as expected '@.*:'. Instead, some weird
> arg identifiers were used.
>
> This change fixes the following warnings:
>
> drivers/regulator/wm8400-regulator.c:243: warning: Function parameter or member 'dev' not described in 'wm8400_register_regulator'
> drivers/regulator/wm8400-regulator.c:243: warning: Function parameter or member 'reg' not described in 'wm8400_register_regulator'
> drivers/regulator/wm8400-regulator.c:243: warning: Function parameter or member 'initdata' not described in 'wm8400_register_regulator'
>
> Cc: [email protected]
> Signed-off-by: Lee Jones <[email protected]>
> ---

Acked-by: Charles Keepax <[email protected]>

Thanks,
Charles