hsi: fix kernel-doc warnings
PATCH 1/1 hsi: fix kernel-doc warnings
From: Randy Dunlap <[email protected]>
Fix kernel-doc warnings in hsi files:
Warning(include/linux/hsi/hsi.h:136): Excess struct/union/enum/typedef member 'e_handler' description in 'hsi_client' Warning(include/linux/hsi/hsi.h:136): Excess struct/union/enum/typedef member 'pclaimed' description in 'hsi_client' Warning(include/linux/hsi/hsi.h:136): Excess struct/union/enum/typedef member 'nb' description in 'hsi_client' Warning(drivers/hsi/hsi.c:434): No description found for parameter 'handler' Warning(drivers/hsi/hsi.c:434): Excess function parameter 'cb' description in 'hsi_register_port_event'
Don't document "private:" fields with kernel-doc notation. If you want to leave them fully documented, that's OK, but then don't mark them as "private:".
--- drivers/hsi/hsi.c | 2 +- include/linux/hsi/hsi.h | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-)
drivers/hsi/hsi.c +1 -1
@@ -420,7 +420,7 @@ static int hsi_event_notifier_call(struc/** * hsi_register_port_event - Register a client to receive port events * @cl: HSI client that wants to receive port events -* @cb: Event handler callback +* @handler: Event handler callback * * Clients should register a callback to be able to receive * events from the ports. Registration should happen after
include/linux/hsi/hsi.h +3 -3
@@ -121,9 +121,9 @@ static inline int hsi_register_board_inf* @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;