lkml.org 
[lkml]   [2020]   [Jun]   [30]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
    Patch in this message
    /
    From
    Subject[PATCH 07/10] gpio: gpio-it87: Fix formatting issues which confuse kerneldoc
    Date
    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'

    Cc: "Diego Elio Pettenò" <flameeyes@flameeyes.eu>
    Signed-off-by: Lee Jones <lee.jones@linaro.org>
    ---
    drivers/gpio/gpio-it87.c | 14 +++++++-------
    1 file changed, 7 insertions(+), 7 deletions(-)

    diff --git a/drivers/gpio/gpio-it87.c b/drivers/gpio/gpio-it87.c
    index b497a1d18ca9b..8f1be34953ce4 100644
    --- a/drivers/gpio/gpio-it87.c
    +++ b/drivers/gpio/gpio-it87.c
    @@ -47,13 +47,13 @@

    /**
    * struct it87_gpio - it87-specific GPIO chip
    - * @chip the underlying gpio_chip structure
    - * @lock a lock to avoid races between operations
    - * @io_base base address for gpio ports
    - * @io_size size of the port rage starting from io_base.
    - * @output_base Super I/O register address for Output Enable register
    - * @simple_base Super I/O 'Simple I/O' Enable register
    - * @simple_size Super IO 'Simple I/O' Enable register size; this is
    + * @chip: the underlying gpio_chip structure
    + * @lock: a lock to avoid races between operations
    + * @io_base: base address for gpio ports
    + * @io_size: size of the port rage starting from io_base.
    + * @output_base: Super I/O register address for Output Enable register
    + * @simple_base: Super I/O 'Simple I/O' Enable register
    + * @simple_size: Super IO 'Simple I/O' Enable register size; this is
    * required because IT87xx chips might only provide Simple I/O
    * switches on a subset of lines, whereas the others keep the
    * same status all time.
    --
    2.25.1
    \
     
     \ /
      Last update: 2020-06-30 15:34    [W:2.775 / U:0.360 seconds]
    ©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site