Commit 403c5c06 authored Oct 08, 2015 by Javier Martinez Canillas Committed by Sebastian Reichel Nov 21, 2015

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>

parent 8005c49d

include/linux/hsi/hsi.h

+0 −3

Original line number	Diff line number	Diff line
		@@ -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;

Admin message