Documentation: Add "@" in front of private structure members.
authorRobert P. J. Day <rpjday@crashcourse.ca>
Fri, 13 Feb 2015 08:46:07 +0000 (03:46 -0500)
committerJonathan Corbet <corbet@lwn.net>
Fri, 27 Feb 2015 21:56:57 +0000 (14:56 -0700)
Even "private" structure members need a leading "@" in their
kernel-doc; otherwise, they will be treated as new section names in
the resulting manual.

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Acked-by: Randy Dunlap <rdunlap@infradead.org>
Acked-By: Sebastian Reichel <sre@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
include/linux/hsi/hsi.h

index 3ec06300d5355a02c33b99ea02e0bdf2c1200ddf..5dd60c2e120f944aa0d35fe7aef607fa605d70f5 100644 (file)
@@ -135,9 +135,9 @@ static inline int hsi_register_board_info(struct hsi_board_info const *info,
  * @device: Driver model representation of the device
  * @tx_cfg: HSI TX configuration
  * @rx_cfg: HSI RX configuration
- * e_handler: Callback for handling port events (RX Wake High/Low)
- * pclaimed: Keeps tracks if the clients claimed its associated HSI port
- * nb: Notifier block for port events
+ * @e_handler: Callback for handling port events (RX Wake High/Low)
+ * @pclaimed: Keeps tracks if the clients claimed its associated HSI port
+ * @nb: Notifier block for port events
  */
 struct hsi_client {
        struct device           device;