MIPS: msi-octeon: eliminate kernel-doc warnings
authorRandy Dunlap <rdunlap@infradead.org>
Sun, 24 Jul 2022 05:57:23 +0000 (22:57 -0700)
committerThomas Bogendoerfer <tsbogend@alpha.franken.de>
Sat, 30 Jul 2022 08:58:26 +0000 (10:58 +0200)
commitd3cd4d9fc1f024b09967e672fb0ef82f05444b75
treee658ace16f228f3c15f8d541a1c9bca4624d170f
parentb8295e44c7619289a7d5024156753c0e3a30daf8
MIPS: msi-octeon: eliminate kernel-doc warnings

Rearrange kernel-doc notation for 2 functions to eliminate
kernel-doc warnings. Use Return: notation for the function
return value description. Add function short descriptions
for both functions.
Correct 2 typos.

Fixes these kernel-doc warnings:

msi-octeon.c:49: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
 * Called when a driver request MSI interrupts instead of the
msi-octeon.c:49: warning: missing initial short description on line:
 * Called when a driver request MSI interrupts instead of the
msi-octeon.c:62: warning: No description found for return value of 'arch_setup_msi_irq'
msi-octeon.c:189: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
 * Called when a device no longer needs its MSI interrupts. All
msi-octeon.c:189: warning: missing initial short description on line:
 * Called when a device no longer needs its MSI interrupts. All

Fixes: e8635b484f64 ("MIPS: Add Cavium OCTEON PCI support.")
Reported-by: kernel test robot <lkp@intel.com>
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Aditya Srivastava <yashsri421@gmail.com>
Cc: Thomas Bogendoerfer <tsbogend@alpha.franken.de>
Cc: linux-mips@vger.kernel.org
Signed-off-by: Thomas Bogendoerfer <tsbogend@alpha.franken.de>
arch/mips/pci/msi-octeon.c