Re: [PATCH] Documentation: Add "@" in front of private structure members.

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



On 02/13/15 00:46, Robert P. J. Day wrote:
> Even "private" structure members need a leading "@" in their
> kernel-doc; otherwise, they will be treated as new section names in
> the resulting manual.
> 
> Signed-off-by: Robert P. J. Day <rpjday@xxxxxxxxxxxxxx>

Acked-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>

Thanks.

> ---
> 
> diff --git a/include/linux/hsi/hsi.h b/include/linux/hsi/hsi.h
> index 3ec0630..5dd60c2 100644
> --- a/include/linux/hsi/hsi.h
> +++ b/include/linux/hsi/hsi.h
> @@ -135,9 +135,9 @@ 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
> + * @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;
> 


-- 
~Randy
--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html




[Index of Archives]     [Kernel Newbies]     [Security]     [Netfilter]     [Bugtraq]     [Linux FS]     [Yosemite Forum]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Samba]     [Video 4 Linux]     [Device Mapper]     [Linux Resources]

  Powered by Linux