public inbox for linux-kernel@vger.kernel.org
 help / color / mirror / Atom feed
* [PATCH resend] hsi: fix kernel-doc warnings
@ 2013-03-01 19:11 Randy Dunlap
  2013-03-04  2:56 ` Linus Walleij
  0 siblings, 1 reply; 3+ messages in thread
From: Randy Dunlap @ 2013-03-01 19:11 UTC (permalink / raw)
  To: LKML, Greg Kroah-Hartman, Linus Torvalds
  Cc: Nishanth Menon, Andrew Morton, Carlos Chinea, Linus Walleij,
	linux-omap

From: Randy Dunlap <rdunlap@infradead.org>

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>
---
 drivers/hsi/hsi.c       |    2 +-
 include/linux/hsi/hsi.h |    6 +++---
 2 files changed, 4 insertions(+), 4 deletions(-)

--- lnx-38.orig/drivers/hsi/hsi.c
+++ lnx-38/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-38.orig/include/linux/hsi/hsi.h
+++ lnx-38/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] 3+ messages in thread
end of thread, other threads:[~2013-03-04  2:57 UTC | newest]

Thread overview: 3+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2013-03-01 19:11 [PATCH resend] hsi: fix kernel-doc warnings Randy Dunlap
2013-03-04  2:56 ` Linus Walleij
2013-03-04  2:58   ` Randy Dunlap

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox