Search Linux Wireless

Re: [PATCH 4/5] wifi: ath10k: Fix htt_data_tx_completion kernel-doc warning

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

 




On 1/18/24 08:12, Jeff Johnson wrote:
> Currently kernel-doc reports:
> drivers/net/wireless/ath/ath10k/htt.h:911: warning: Cannot understand  * @brief target -> host TX completion indication message definition
>  on line 911 - I thought it was a doc line
> 
> This is because even though struct htt_data_tx_completion uses the
> kernel-doc marker "/**", it doesn't actual use kernel-doc syntax for
> the documentation. Rather than try to update this legacy driver
> documentation to use kernel-doc style, just replace the comment
> marker.
> 
> No functional changes, compile tested only.
> 
> Signed-off-by: Jeff Johnson <quic_jjohnson@xxxxxxxxxxx>

Acked-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>

Thanks.

> ---
>  drivers/net/wireless/ath/ath10k/htt.h | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/drivers/net/wireless/ath/ath10k/htt.h b/drivers/net/wireless/ath/ath10k/htt.h
> index eb0ce2f49315..603f6de62b0a 100644
> --- a/drivers/net/wireless/ath/ath10k/htt.h
> +++ b/drivers/net/wireless/ath/ath10k/htt.h
> @@ -906,7 +906,7 @@ struct htt_data_tx_completion_ext {
>  	__le16 msdus_rssi[];
>  } __packed;
>  
> -/**
> +/*
>   * @brief target -> host TX completion indication message definition
>   *
>   * @details
> 

-- 
#Randy




[Index of Archives]     [Linux Host AP]     [ATH6KL]     [Linux Wireless Personal Area Network]     [Linux Bluetooth]     [Wireless Regulations]     [Linux Netdev]     [Kernel Newbies]     [Linux Kernel]     [IDE]     [Git]     [Netfilter]     [Bugtraq]     [Yosemite Hiking]     [MIPS Linux]     [ARM Linux]     [Linux RAID]

  Powered by Linux