wifi: ath10k: Fix htt_data_tx_completion kernel-doc warning
authorJeff Johnson <quic_jjohnson@quicinc.com>
Thu, 18 Jan 2024 16:12:56 +0000 (08:12 -0800)
committerKalle Valo <quic_kvalo@quicinc.com>
Fri, 19 Jan 2024 17:43:11 +0000 (19:43 +0200)
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@quicinc.com>
Acked-by: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: Kalle Valo <quic_kvalo@quicinc.com>
Link: https://msgid.link/20240118-ath10k-kerneldoc-v1-4-99c7e8d95aad@quicinc.com
drivers/net/wireless/ath/ath10k/htt.h

index eb0ce2f49315009692f4c3229261a5fca8fba63c..603f6de62b0a02f4f0d1ac64af46b635b001c2ee 100644 (file)
@@ -906,7 +906,7 @@ struct htt_data_tx_completion_ext {
        __le16 msdus_rssi[];
 } __packed;
 
-/**
+/*
  * @brief target -> host TX completion indication message definition
  *
  * @details