diff options
author | Randy Dunlap <rdunlap@infradead.org> | 2013-03-01 14:11:47 -0500 |
---|---|---|
committer | Linus Torvalds <torvalds@linux-foundation.org> | 2013-03-01 16:39:00 -0500 |
commit | 8eae508b7c6ff502a71d0293b69e97c5505d5840 (patch) | |
tree | 5a9f39523f39379454ab5eb8337b8a017984525c | |
parent | cc73dc04c7b3e18ac20ef7770d4964765e4d6ddf (diff) |
hsi: fix kernel-doc warnings
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:".
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Carlos Chinea <carlos.chinea@nokia.com>
Cc: Linus Walleij <linus.walleij@linaro.org>
Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Cc: linux-kernel@vger.kernel.org
Cc: linux-omap@vger.kernel.org
Acked-by: Nishanth Menon <nm@ti.com>
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
-rw-r--r-- | drivers/hsi/hsi.c | 2 | ||||
-rw-r--r-- | include/linux/hsi/hsi.h | 6 |
2 files changed, 4 insertions, 4 deletions
diff --git a/drivers/hsi/hsi.c b/drivers/hsi/hsi.c index 2d58f939d27f..833dd1afbf46 100644 --- a/drivers/hsi/hsi.c +++ b/drivers/hsi/hsi.c | |||
@@ -420,7 +420,7 @@ static int hsi_event_notifier_call(struct notifier_block *nb, | |||
420 | /** | 420 | /** |
421 | * hsi_register_port_event - Register a client to receive port events | 421 | * hsi_register_port_event - Register a client to receive port events |
422 | * @cl: HSI client that wants to receive port events | 422 | * @cl: HSI client that wants to receive port events |
423 | * @cb: Event handler callback | 423 | * @handler: Event handler callback |
424 | * | 424 | * |
425 | * Clients should register a callback to be able to receive | 425 | * Clients should register a callback to be able to receive |
426 | * events from the ports. Registration should happen after | 426 | * events from the ports. Registration should happen after |
diff --git a/include/linux/hsi/hsi.h b/include/linux/hsi/hsi.h index 56fae865e272..0dca785288cf 100644 --- a/include/linux/hsi/hsi.h +++ b/include/linux/hsi/hsi.h | |||
@@ -121,9 +121,9 @@ static inline int hsi_register_board_info(struct hsi_board_info const *info, | |||
121 | * @device: Driver model representation of the device | 121 | * @device: Driver model representation of the device |
122 | * @tx_cfg: HSI TX configuration | 122 | * @tx_cfg: HSI TX configuration |
123 | * @rx_cfg: HSI RX configuration | 123 | * @rx_cfg: HSI RX configuration |
124 | * @e_handler: Callback for handling port events (RX Wake High/Low) | 124 | * e_handler: Callback for handling port events (RX Wake High/Low) |
125 | * @pclaimed: Keeps tracks if the clients claimed its associated HSI port | 125 | * pclaimed: Keeps tracks if the clients claimed its associated HSI port |
126 | * @nb: Notifier block for port events | 126 | * nb: Notifier block for port events |
127 | */ | 127 | */ |
128 | struct hsi_client { | 128 | struct hsi_client { |
129 | struct device device; | 129 | struct device device; |