Re: [PATCH] HSI: Remove struct hsi_client private fields from kernel-doc

[Javier Martinez Canillas <javier@osg.samsung.com>]

Hello Sebastian,

On 10/08/2015 04:11 AM, Javier Martinez Canillas wrote:
> 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>
> 
> ---
> 
>  include/linux/hsi/hsi.h | 3 ---
>  1 file changed, 3 deletions(-)
> 
> diff --git a/include/linux/hsi/hsi.h b/include/linux/hsi/hsi.h
> index 5dd60c2e120f..2790591c77cf 100644
> --- a/include/linux/hsi/hsi.h
> +++ b/include/linux/hsi/hsi.h
> @@ -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;
> 

Any comments about this patch?

Best regards,
-- 
Javier Martinez Canillas
Open Source Group
Samsung Research America