diff mbox series

mailbox: xgene-slimpro: fix kernel-doc warnings

Message ID 20240115000224.2854-1-rdunlap@infradead.org
State New
Headers
Series mailbox: xgene-slimpro: fix kernel-doc warnings |

Commit Message

Randy Dunlap Jan. 15, 2024, 12:02 a.m. UTC 
  Convert struct comments to kernel-doc format to avoid warnings
from scripts/kernel-doc:

mailbox-xgene-slimpro.c:3: warning: cannot understand function prototype: 'struct slimpro_mbox_chan '
mailbox-xgene-slimpro.c:57: warning: contents before sections
mailbox-xgene-slimpro.c:62: warning: cannot understand function prototype: 'struct slimpro_mbox '

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Feng Kan <fkan@apm.com>
Cc: Jassi Brar <jassisinghbrar@gmail.com>
---
 drivers/mailbox/mailbox-xgene-slimpro.c |    9 ++++-----
 1 file changed, 4 insertions(+), 5 deletions(-)
diff mbox series

Patch

diff -- a/drivers/mailbox/mailbox-xgene-slimpro.c b/drivers/mailbox/mailbox-xgene-slimpro.c
--- a/drivers/mailbox/mailbox-xgene-slimpro.c
+++ b/drivers/mailbox/mailbox-xgene-slimpro.c
@@ -32,7 +32,7 @@ 
 #define REG_DB_STATMASK		0x24
 
 /**
- * X-Gene SlimPRO mailbox channel information
+ * struct slimpro_mbox_chan - X-Gene SlimPRO mailbox channel information
  *
  * @dev:	Device to which it is attached
  * @chan:	Pointer to mailbox communication channel
@@ -49,15 +49,14 @@  struct slimpro_mbox_chan {
 };
 
 /**
- * X-Gene SlimPRO Mailbox controller data
- *
- * X-Gene SlimPRO Mailbox controller has 8 communication channels.
- * Each channel has a separate IRQ number assigned to it.
+ * struct slimpro_mbox - X-Gene SlimPRO Mailbox controller data
  *
  * @mb_ctrl:	Representation of the communication channel controller
  * @mc:		Array of SlimPRO mailbox channels of the controller
  * @chans:	Array of mailbox communication channels
  *
+ * X-Gene SlimPRO Mailbox controller has 8 communication channels.
+ * Each channel has a separate IRQ number assigned to it.
  */
 struct slimpro_mbox {
 	struct mbox_controller		mb_ctrl;