Skip to content

Commit

Permalink
Documentation: Add "@" in front of private structure members.
Browse files Browse the repository at this point in the history
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 <[email protected]>
Acked-by: Randy Dunlap <[email protected]>
Acked-By: Sebastian Reichel <[email protected]>
Signed-off-by: Jonathan Corbet <[email protected]>
  • Loading branch information
rpjday authored and Jonathan Corbet committed Feb 27, 2015
1 parent dce1239 commit 9e39dc1
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions include/linux/hsi/hsi.h
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down

0 comments on commit 9e39dc1

Please sign in to comment.