HSI: Remove struct hsi_client private fields from kernel-doc
authorJavier Martinez Canillas <javier@osg.samsung.com>
Thu, 8 Oct 2015 07:11:48 +0000 (09:11 +0200)
committerSebastian Reichel <sre@kernel.org>
Sat, 21 Nov 2015 17:42:00 +0000 (18:42 +0100)
The kernel-doc how to says that structure fields that are inside a
"private:" area shouldn't be listed in the generated documentation
but the private fields for struct hsi_client private are listed.

This also fixes the following make htmldocs warnings:

.//include/linux/hsi/hsi.h:150: warning: Excess struct/union/enum/typedef member 'e_handler' description in 'hsi_client'
.//include/linux/hsi/hsi.h:150: warning: Excess struct/union/enum/typedef member 'pclaimed' description in 'hsi_client'
.//include/linux/hsi/hsi.h:150: warning: Excess struct/union/enum/typedef member 'nb' description in 'hsi_client'

Signed-off-by: Javier Martinez Canillas <javier@osg.samsung.com>
Signed-off-by: Sebastian Reichel <sre@kernel.org>
include/linux/hsi/hsi.h

index 5dd60c2e120f944aa0d35fe7aef607fa605d70f5..2790591c77cf681013e2b0ef99390d31c8b06f1c 100644 (file)
@@ -135,9 +135,6 @@ static inline int hsi_register_board_info(struct hsi_board_info const *info,
  * @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
  */
 struct hsi_client {
        struct device           device;