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

HSI: Remove struct hsi_client private fields from kernel-doc

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>

authored by

Javier Martinez Canillas and committed by
Sebastian Reichel
403c5c06 8005c49d

-3
-3
include/linux/hsi/hsi.h
··· 135 135 * @device: Driver model representation of the device 136 136 * @tx_cfg: HSI TX configuration 137 137 * @rx_cfg: HSI RX configuration 138 - * @e_handler: Callback for handling port events (RX Wake High/Low) 139 - * @pclaimed: Keeps tracks if the clients claimed its associated HSI port 140 - * @nb: Notifier block for port events 141 138 */ 142 139 struct hsi_client { 143 140 struct device device;