Skip to content

Commit

Permalink
HSI: Remove struct hsi_client private fields from kernel-doc
Browse files Browse the repository at this point in the history
The kernel-doc how to says that structure fields that are inside a
"private:" area shouldn't be listed in the generated documentation
but the private fields for struct hsi_client private are listed.

This also fixes the following make htmldocs warnings:

.//include/linux/hsi/hsi.h:150: warning: Excess struct/union/enum/typedef member 'e_handler' description in 'hsi_client'
.//include/linux/hsi/hsi.h:150: warning: Excess struct/union/enum/typedef member 'pclaimed' description in 'hsi_client'
.//include/linux/hsi/hsi.h:150: warning: Excess struct/union/enum/typedef member 'nb' description in 'hsi_client'

Signed-off-by: Javier Martinez Canillas <[email protected]>
Signed-off-by: Sebastian Reichel <[email protected]>
  • Loading branch information
Javier Martinez Canillas authored and sre committed Nov 21, 2015
1 parent 8005c49 commit 403c5c0
Showing 1 changed file with 0 additions and 3 deletions.
3 changes: 0 additions & 3 deletions include/linux/hsi/hsi.h
Original file line number Diff line number Diff line change
Expand Up @@ -135,9 +135,6 @@ 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
*/
struct hsi_client {
struct device device;
Expand Down

0 comments on commit 403c5c0

Please sign in to comment.