• Randy Dunlap's avatar
    mailbox: sti: quieten kernel-doc warnings · 23e6a7ca
    Randy Dunlap authored
    Use kernel-doc struct notation for the mailbox structs to prevent
    these kernel-doc warnings:
    
       drivers/mailbox/mailbox-sti.c:39: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
        * STi Mailbox device data
       drivers/mailbox/mailbox-sti.c:63: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
        * STi Mailbox platform specific configuration
       drivers/mailbox/mailbox-sti.c:74: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
        * STi Mailbox allocated channel information
    
    Also move the field descriptions ahead of the function description as
    is expected in kernel-doc. This prevents another kernel-doc warning.
    
    Fixes: 9ef4546c ("mailbox: Add support for ST's Mailbox IP")
    Signed-off-by: default avatarRandy Dunlap <rdunlap@infradead.org>
    Reported-by: default avatarkernel test robot <lkp@intel.com>
    Cc: Aditya Srivastava <yashsri421@gmail.com>
    Cc: Lee Jones <lee.jones@linaro.org>
    Signed-off-by: default avatarJassi Brar <jaswinder.singh@linaro.org>
    23e6a7ca
mailbox-sti.c 13 KB