[PATCH] ath9k-common: fix kernel-doc warnings in common-debug.h

[PATCH] ath9k-common: fix kernel-doc warnings in common-debug.h

[Randy Dunlap]

Modify kernel-doc comments in common-debug.h to avoid warnings:

Warning: drivers/net/wireless/ath/ath9k/common-debug.h:21 bad line:
  may have had errors.
Warning: ../drivers/net/wireless/ath/ath9k/common-debug.h:23 bad line:
  may have had errors.
Warning: ../drivers/net/wireless/ath/ath9k/common-debug.h:26 bad line:
  decryption process completed
Warning: ../drivers/net/wireless/ath/ath9k/common-debug.h:28 bad line:
  encountered an error

Fixes: 99c15bf575b1 ("ath9k: Report total tx/rx bytes and packets in debugfs.")
Fixes: 1395d3f00a41 ("ath9k: Add debugfs file for RX errors") (last 2)
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
---
Cc: Toke Høiland-Jørgensen <toke@toke.dk>
Cc: Johannes Berg <johannes@sipsolutions.net>
Cc: linux-wireless@vger.kernel.org
---
 drivers/net/wireless/ath/ath9k/common-debug.h |    8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

--- linux-next-20251107.orig/drivers/net/wireless/ath/ath9k/common-debug.h
+++ linux-next-20251107/drivers/net/wireless/ath/ath9k/common-debug.h
@@ -19,14 +19,14 @@
 /**
  * struct ath_rx_stats - RX Statistics
  * @rx_pkts_all:  No. of total frames received, including ones that
-	may have had errors.
+ *	may have had errors.
  * @rx_bytes_all:  No. of total bytes received, including ones that
-	may have had errors.
+ *	may have had errors.
  * @crc_err: No. of frames with incorrect CRC value
  * @decrypt_crc_err: No. of frames whose CRC check failed after
-	decryption process completed
+ *	decryption process completed
  * @phy_err: No. of frames whose reception failed because the PHY
-	encountered an error
+ *	encountered an error
  * @mic_err: No. of frames with incorrect TKIP MIC verification failure
  * @pre_delim_crc_err: Pre-Frame delimiter CRC error detections
  * @post_delim_crc_err: Post-Frame delimiter CRC error detections

Re: [PATCH] ath9k-common: fix kernel-doc warnings in common-debug.h

[Toke Høiland-Jørgensen]

Randy Dunlap <rdunlap@infradead.org> writes:

> Modify kernel-doc comments in common-debug.h to avoid warnings:
>
> Warning: drivers/net/wireless/ath/ath9k/common-debug.h:21 bad line:
>   may have had errors.
> Warning: ../drivers/net/wireless/ath/ath9k/common-debug.h:23 bad line:
>   may have had errors.
> Warning: ../drivers/net/wireless/ath/ath9k/common-debug.h:26 bad line:
>   decryption process completed
> Warning: ../drivers/net/wireless/ath/ath9k/common-debug.h:28 bad line:
>   encountered an error
>
> Fixes: 99c15bf575b1 ("ath9k: Report total tx/rx bytes and packets in debugfs.")
> Fixes: 1395d3f00a41 ("ath9k: Add debugfs file for RX errors") (last 2)
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>

Acked-by: Toke Høiland-Jørgensen <toke@toke.dk>

Re: [PATCH] ath9k-common: fix kernel-doc warnings in common-debug.h

[Jeff Johnson]

On Sun, 16 Nov 2025 18:02:50 -0800, Randy Dunlap wrote:
> Modify kernel-doc comments in common-debug.h to avoid warnings:
> 
> Warning: drivers/net/wireless/ath/ath9k/common-debug.h:21 bad line:
>   may have had errors.
> Warning: ../drivers/net/wireless/ath/ath9k/common-debug.h:23 bad line:
>   may have had errors.
> Warning: ../drivers/net/wireless/ath/ath9k/common-debug.h:26 bad line:
>   decryption process completed
> Warning: ../drivers/net/wireless/ath/ath9k/common-debug.h:28 bad line:
>   encountered an error
> 
> [...]

Applied, thanks!

[1/1] ath9k-common: fix kernel-doc warnings in common-debug.h
      commit: b9909c19965dc9e5a3a898fef09b437fcc3a9494

Best regards,
-- 
Jeff Johnson <jeff.johnson@oss.qualcomm.com>