linux-kernel - [PATCH] mailbox: xgene-slimpro: fix kernel-doc warnings

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [day] [month] [year] [list]

Message-ID: <20240115000224.2854-1-rdunlap@infradead.org>
Date: Sun, 14 Jan 2024 16:02:24 -0800
From: Randy Dunlap <rdunlap@...radead.org>
To: linux-kernel@...r.kernel.org
Cc: Randy Dunlap <rdunlap@...radead.org>,
	Feng Kan <fkan@....com>,
	Jassi Brar <jassisinghbrar@...il.com>
Subject: [PATCH] mailbox: xgene-slimpro: fix kernel-doc warnings

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@...radead.org>
Cc: Feng Kan <fkan@....com>
Cc: Jassi Brar <jassisinghbrar@...il.com>
---
 drivers/mailbox/mailbox-xgene-slimpro.c |    9 ++++-----
 1 file changed, 4 insertions(+), 5 deletions(-)

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;