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

gpio: gpio-it87: Fix formatting issues which confuse kerneldoc

Kerneldoc expects struct properties to be documented using the syntax
'@.*: ', but no ':' has been provided in 'struct it87_gpio's
header. Add them to stop confusing kerneldoc.

Fixes the following W=1 warnings:

drivers/gpio/gpio-it87.c:69: warning: Function parameter or member 'chip' not described in 'it87_gpio'
drivers/gpio/gpio-it87.c:69: warning: Function parameter or member 'lock' not described in 'it87_gpio'
drivers/gpio/gpio-it87.c:69: warning: Function parameter or member 'io_base' not described in 'it87_gpio'
drivers/gpio/gpio-it87.c:69: warning: Function parameter or member 'io_size' not described in 'it87_gpio'
drivers/gpio/gpio-it87.c:69: warning: Function parameter or member 'output_base' not described in 'it87_gpio'
drivers/gpio/gpio-it87.c:69: warning: Function parameter or member 'simple_base' not described in 'it87_gpio'
drivers/gpio/gpio-it87.c:69: warning: Function parameter or member 'simple_size' not described in 'it87_gpio'

Signed-off-by: Lee Jones <lee.jones@linaro.org>
Cc: "Diego Elio Pettenò" <flameeyes@flameeyes.eu>
Link: https://lore.kernel.org/r/20200630133345.2232932-8-lee.jones@linaro.org
Signed-off-by: Linus Walleij <linus.walleij@linaro.org>

authored by

Lee Jones and committed by
Linus Walleij
4e291290 5f3beb67

+7 -7
+7 -7
drivers/gpio/gpio-it87.c
··· 47 47 48 48 /** 49 49 * struct it87_gpio - it87-specific GPIO chip 50 - * @chip the underlying gpio_chip structure 51 - * @lock a lock to avoid races between operations 52 - * @io_base base address for gpio ports 53 - * @io_size size of the port rage starting from io_base. 54 - * @output_base Super I/O register address for Output Enable register 55 - * @simple_base Super I/O 'Simple I/O' Enable register 56 - * @simple_size Super IO 'Simple I/O' Enable register size; this is 50 + * @chip: the underlying gpio_chip structure 51 + * @lock: a lock to avoid races between operations 52 + * @io_base: base address for gpio ports 53 + * @io_size: size of the port rage starting from io_base. 54 + * @output_base: Super I/O register address for Output Enable register 55 + * @simple_base: Super I/O 'Simple I/O' Enable register 56 + * @simple_size: Super IO 'Simple I/O' Enable register size; this is 57 57 * required because IT87xx chips might only provide Simple I/O 58 58 * switches on a subset of lines, whereas the others keep the 59 59 * same status all time.