linux-wireless.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Jeff Johnson <quic_jjohnson@quicinc.com>
To: Kalle Valo <kvalo@kernel.org>, Jeff Johnson <quic_jjohnson@quicinc.com>
Cc: <ath10k@lists.infradead.org>, <linux-wireless@vger.kernel.org>,
	<linux-kernel@vger.kernel.org>
Subject: [PATCH 4/5] wifi: ath10k: Fix htt_data_tx_completion kernel-doc warning
Date: Thu, 18 Jan 2024 08:12:56 -0800	[thread overview]
Message-ID: <20240118-ath10k-kerneldoc-v1-4-99c7e8d95aad@quicinc.com> (raw)
In-Reply-To: <20240118-ath10k-kerneldoc-v1-0-99c7e8d95aad@quicinc.com>

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(-)

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

-- 
2.42.0


  parent reply	other threads:[~2024-01-18 16:13 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-01-18 16:12 [PATCH 0/5] wifi: ath10k: fix ath10k kerneldoc issues Jeff Johnson
2024-01-18 16:12 ` [PATCH 1/5] wifi: ath10k: add missing wmi_10_4_feature_mask documentation Jeff Johnson
2024-01-19 17:43   ` Kalle Valo
2024-01-18 16:12 ` [PATCH 2/5] wifi: ath10k: correctly document enum wmi_tlv_tx_pause_id Jeff Johnson
2024-01-18 17:17   ` Randy Dunlap
2024-01-18 16:12 ` [PATCH 3/5] wifi: ath10k: fix htt_q_state_conf & htt_q_state kernel-doc Jeff Johnson
2024-01-18 17:18   ` Randy Dunlap
2024-01-18 16:12 ` Jeff Johnson [this message]
2024-01-18 17:19   ` [PATCH 4/5] wifi: ath10k: Fix htt_data_tx_completion kernel-doc warning Randy Dunlap
2024-01-18 16:12 ` [PATCH 5/5] wifi: ath10k: Fix enum ath10k_fw_crash_dump_type kernel-doc Jeff Johnson
2024-01-18 17:20   ` Randy Dunlap

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20240118-ath10k-kerneldoc-v1-4-99c7e8d95aad@quicinc.com \
    --to=quic_jjohnson@quicinc.com \
    --cc=ath10k@lists.infradead.org \
    --cc=kvalo@kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-wireless@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body. 
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).