mailbox: sti: quieten kernel-doc warnings
authorRandy Dunlap <rdunlap@infradead.org>
Fri, 23 Jul 2021 18:25:58 +0000 (11:25 -0700)
committerJassi Brar <jaswinder.singh@linaro.org>
Mon, 30 Aug 2021 04:50:12 +0000 (23:50 -0500)
commit23e6a7ca464ed2b9d949520e07f7e0735bc025f4
tree3a44d52ae96804afe1bf77ecc68cb0b54b2bdd06
parente22ce8eb631bdc47a4a4ea7ecf4e4ba499db4f93
mailbox: sti: quieten kernel-doc warnings

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: 9ef4546cbd7e ("mailbox: Add support for ST's Mailbox IP")
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Reported-by: kernel test robot <lkp@intel.com>
Cc: Aditya Srivastava <yashsri421@gmail.com>
Cc: Lee Jones <lee.jones@linaro.org>
Signed-off-by: Jassi Brar <jaswinder.singh@linaro.org>
drivers/mailbox/mailbox-sti.c