• M
    kernel-doc: parse DECLARE_KFIFO and DECLARE_KFIFO_PTR() · 45005b27
    Mauro Carvalho Chehab 提交于
    On media, we now have an struct declared with:
    
    struct lirc_fh {
            struct list_head list;
            struct rc_dev *rc;
            int                             carrier_low;
            bool                            send_timeout_reports;
            DECLARE_KFIFO_PTR(rawir, unsigned int);
            DECLARE_KFIFO_PTR(scancodes, struct lirc_scancode);
            wait_queue_head_t               wait_poll;
            u8                              send_mode;
            u8                              rec_mode;
    };
    
    gpiolib.c has a similar declaration with DECLARE_KFIFO().
    
    Currently, those produce the following error:
    
    	./include/media/rc-core.h:96: warning: No description found for parameter 'int'
    	./include/media/rc-core.h:96: warning: No description found for parameter 'lirc_scancode'
    	./include/media/rc-core.h:96: warning: Excess struct member 'rawir' description in 'lirc_fh'
    	./include/media/rc-core.h:96: warning: Excess struct member 'scancodes' description in 'lirc_fh'
    	../drivers/gpio/gpiolib.c:601: warning: No description found for parameter '16'
    	../drivers/gpio/gpiolib.c:601: warning: Excess struct member 'events' description in 'lineevent_state'
    
    So, teach kernel-doc how to parse DECLARE_KFIFO() and DECLARE_KFIFO_PTR().
    
    While here, relax at the past DECLARE_foo() macros, accepting a random
    number of spaces after comma.
    
    The addition of DECLARE_KFIFO() was
    Suggested-by: NRandy Dunlap <rdunlap@infradead.org>
    Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>
    Tested-by: NRandy Dunlap <rdunlap@infradead.org>
    Signed-off-by: NJonathan Corbet <corbet@lwn.net>
    45005b27
kernel-doc 92.6 KB