All of lore.kernel.org
 help / color / mirror / Atom feed
* [PATCH] hsi: fix kernel-doc warnings
@ 2012-05-13 17:50 Randy Dunlap
  0 siblings, 0 replies; only message in thread
From: Randy Dunlap @ 2012-05-13 17:50 UTC (permalink / raw)
  To: LKML; +Cc: Carlos Chinea, Linus Walleij, Greg Kroah-Hartman

From: Randy Dunlap <rdunlap@xenotime.net>

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@xenotime.net>
Cc: Carlos Chinea <carlos.chinea@nokia.com>
Cc: Linus Walleij <linus.walleij@linaro.org>
Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
---
 drivers/hsi/hsi.c       |    2 +-
 include/linux/hsi/hsi.h |    6 +++---
 2 files changed, 4 insertions(+), 4 deletions(-)

--- lnx-34-rc7.orig/drivers/hsi/hsi.c
+++ lnx-34-rc7/drivers/hsi/hsi.c
@@ -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
--- lnx-34-rc7.orig/include/linux/hsi/hsi.h
+++ lnx-34-rc7/include/linux/hsi/hsi.h
@@ -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;

^ permalink raw reply	[flat|nested] only message in thread

only message in thread, other threads:[~2012-05-13 17:50 UTC | newest]

Thread overview: (only message) (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2012-05-13 17:50 [PATCH] hsi: fix kernel-doc warnings Randy Dunlap

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.