| Message ID | 20240118-ath10k-kerneldoc-v1-4-99c7e8d95aad@quicinc.com (mailing list archive) |
|---|---|
| State | Accepted |
| Commit | c80cc5cfefbaca35e019a26f31faa11031c13665 |
| Delegated to: | Kalle Valo |
| Headers | show |
| Series | wifi: ath10k: fix ath10k kerneldoc issues | expand |
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@quicinc.com> Acked-by: Randy Dunlap <rdunlap@infradead.org> 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 >
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
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> --- drivers/net/wireless/ath/ath10k/htt.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)