Re: [PATCH 06/10] gpio: gpio-syscon: Fix formatting issues which confuse kerneldoc
From: Linus Walleij
Date: Wed Jul 08 2020 - 03:18:44 EST
On Tue, Jun 30, 2020 at 3:33 PM Lee Jones <lee.jones@xxxxxxxxxx> wrote:
> Kerneldoc expects struct properties to be documented using the syntax
> '@.*: ', but no '@' has been provided in 'struct syscon_gpio_data's
> header. Add them to stop confusing kerneldoc.
>
> Fixes the following W=1 warnings:
>
> drivers/gpio/gpio-syscon.c:48: warning: Function parameter or member 'compatible' not described in 'syscon_gpio_data'
> drivers/gpio/gpio-syscon.c:48: warning: Function parameter or member 'flags' not described in 'syscon_gpio_data'
> drivers/gpio/gpio-syscon.c:48: warning: Function parameter or member 'bit_count' not described in 'syscon_gpio_data'
> drivers/gpio/gpio-syscon.c:48: warning: Function parameter or member 'dat_bit_offset' not described in 'syscon_gpio_data'
> drivers/gpio/gpio-syscon.c:48: warning: Function parameter or member 'dir_bit_offset' not described in 'syscon_gpio_data'
> drivers/gpio/gpio-syscon.c:48: warning: Function parameter or member 'set' not described in 'syscon_gpio_data'
>
> Cc: Alexander Shiyan <shc_work@xxxxxxx>
> Signed-off-by: Lee Jones <lee.jones@xxxxxxxxxx>
Patch applied!
Yours,
Linus Walleij