Re: [PATCH 09/10] mfd: atmel-smc: Add missing colon(s) for 'conf' arguments

From: Alexandre Belloni
Date: Fri Jun 26 2020 - 16:57:02 EST


On 25/06/2020 07:46:18+0100, Lee Jones wrote:
> Kerneldoc valication gets confused if syntax isn't "@.*: ".
>
> Adding the missing colons squashes the following W=1 warnings:
>
> drivers/mfd/atmel-smc.c:247: warning: Function parameter or member 'conf' not described in 'atmel_smc_cs_conf_apply'
> drivers/mfd/atmel-smc.c:268: warning: Function parameter or member 'conf' not described in 'atmel_hsmc_cs_conf_apply'
>
Reviewed-by: Alexandre Belloni <alexandre.belloni@xxxxxxxxxxx>

> Cc: <stable@xxxxxxxxxxxxxxx>
> Cc: Nicolas Ferre <nicolas.ferre@xxxxxxxxxxxxx>
> Cc: Alexandre Belloni <alexandre.belloni@xxxxxxxxxxx>
> Cc: Ludovic Desroches <ludovic.desroches@xxxxxxxxxxxxx>
> Cc: Boris Brezillon <boris.brezillon@xxxxxxxxxxxxxxxxxx>
> Signed-off-by: Lee Jones <lee.jones@xxxxxxxxxx>
> ---
> drivers/mfd/atmel-smc.c | 4 ++--
> 1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/drivers/mfd/atmel-smc.c b/drivers/mfd/atmel-smc.c
> index 17bbe9d1fa740..4aac96d213369 100644
> --- a/drivers/mfd/atmel-smc.c
> +++ b/drivers/mfd/atmel-smc.c
> @@ -237,7 +237,7 @@ EXPORT_SYMBOL_GPL(atmel_smc_cs_conf_set_cycle);
> * atmel_smc_cs_conf_apply - apply an SMC CS conf
> * @regmap: the SMC regmap
> * @cs: the CS id
> - * @conf the SMC CS conf to apply
> + * @conf: the SMC CS conf to apply
> *
> * Applies an SMC CS configuration.
> * Only valid on at91sam9/avr32 SoCs.
> @@ -257,7 +257,7 @@ EXPORT_SYMBOL_GPL(atmel_smc_cs_conf_apply);
> * @regmap: the HSMC regmap
> * @cs: the CS id
> * @layout: the layout of registers
> - * @conf the SMC CS conf to apply
> + * @conf: the SMC CS conf to apply
> *
> * Applies an SMC CS configuration.
> * Only valid on post-sama5 SoCs.
> --
> 2.25.1
>

--
Alexandre Belloni, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com