Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

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>

authored by

Randy Dunlap and committed by
Linus Torvalds
8eae508b cc73dc04

+4 -4
+1 -1
drivers/hsi/hsi.c
··· 420 420 /** 421 421 * hsi_register_port_event - Register a client to receive port events 422 422 * @cl: HSI client that wants to receive port events 423 - * @cb: Event handler callback 423 + * @handler: Event handler callback 424 424 * 425 425 * Clients should register a callback to be able to receive 426 426 * events from the ports. Registration should happen after
+3 -3
include/linux/hsi/hsi.h
··· 121 121 * @device: Driver model representation of the device 122 122 * @tx_cfg: HSI TX configuration 123 123 * @rx_cfg: HSI RX configuration 124 - * @e_handler: Callback for handling port events (RX Wake High/Low) 125 - * @pclaimed: Keeps tracks if the clients claimed its associated HSI port 126 - * @nb: Notifier block for port events 124 + * e_handler: Callback for handling port events (RX Wake High/Low) 125 + * pclaimed: Keeps tracks if the clients claimed its associated HSI port 126 + * nb: Notifier block for port events 127 127 */ 128 128 struct hsi_client { 129 129 struct device device;