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

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

kernel os linux

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'

Signed-off-by: Lee Jones <lee.jones@linaro.org>
Cc: Alexander Shiyan <shc_work@mail.ru>
Link: https://lore.kernel.org/r/20200630133345.2232932-7-lee.jones@linaro.org
Signed-off-by: Linus Walleij <linus.walleij@linaro.org>

authored by

Lee Jones and committed by

Linus Walleij 5 years ago 5f3beb67 392a5846

+6 -6

1 changed file

expand all

drivers

gpio

gpio-syscon.c

+6 -6

drivers/gpio/gpio-syscon.c

··· 24 24 25 25 /** 26 26 * struct syscon_gpio_data - Configuration for the device. 27 - * compatible: SYSCON driver compatible string. 28 - * flags: Set of GPIO_SYSCON_FEAT_ flags: 27 + * @compatible: SYSCON driver compatible string. 28 + * @flags: Set of GPIO_SYSCON_FEAT_ flags: 29 29 * GPIO_SYSCON_FEAT_IN: GPIOs supports input, 30 30 * GPIO_SYSCON_FEAT_OUT: GPIOs supports output, 31 31 * GPIO_SYSCON_FEAT_DIR: GPIOs supports switch direction. 32 - * bit_count: Number of bits used as GPIOs. 33 - * dat_bit_offset: Offset (in bits) to the first GPIO bit. 34 - * dir_bit_offset: Optional offset (in bits) to the first bit to switch 32 + * @bit_count: Number of bits used as GPIOs. 33 + * @dat_bit_offset: Offset (in bits) to the first GPIO bit. 34 + * @dir_bit_offset: Optional offset (in bits) to the first bit to switch 35 35 * GPIO direction (Used with GPIO_SYSCON_FEAT_DIR flag). 36 - * set: HW specific callback to assigns output value 36 + * @set: HW specific callback to assigns output value 37 37 * for signal "offset" 38 38 */ 39 39