diff mbox series

[1/2] wifi: ath11k: fix hal_rx_buf_return_buf_manager documentation

Message ID 20240329-hal_rx_buf_return_buf_manager-v1-1-e62ec9dc2af9@quicinc.com (mailing list archive)
State Accepted
Commit 68d1beaf3ebbe530dcb00a4599aa566f95e8166a
Delegated to: Kalle Valo
Headers show
Series wifi: ath: fix hal_rx_buf_return_buf_manager documentation | expand

Commit Message

Jeff Johnson March 29, 2024, 11:30 p.m. UTC
kernel-doc flagged the following issue, so fix it:

drivers/net/wireless/ath/ath11k/hal.h:668: warning: missing initial short description on line:
 * enum hal_rx_buf_return_buf_manager

Signed-off-by: Jeff Johnson <quic_jjohnson@quicinc.com>
---
 drivers/net/wireless/ath/ath11k/hal.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Kalle Valo April 4, 2024, 10:11 a.m. UTC | #1
Jeff Johnson <quic_jjohnson@quicinc.com> wrote:

> kernel-doc flagged the following issue, so fix it:
> 
> drivers/net/wireless/ath/ath11k/hal.h:668: warning: missing initial short description on line:
>  * enum hal_rx_buf_return_buf_manager
> 
> Signed-off-by: Jeff Johnson <quic_jjohnson@quicinc.com>
> Signed-off-by: Kalle Valo <quic_kvalo@quicinc.com>

2 patches applied to ath-next branch of ath.git, thanks.

68d1beaf3ebb wifi: ath11k: fix hal_rx_buf_return_buf_manager documentation
024c4ab0415f wifi: ath12k: fix hal_rx_buf_return_buf_manager documentation
diff mbox series

Patch

diff --git a/drivers/net/wireless/ath/ath11k/hal.h b/drivers/net/wireless/ath/ath11k/hal.h
index 65e8f244ebb9..e453c137385e 100644
--- a/drivers/net/wireless/ath/ath11k/hal.h
+++ b/drivers/net/wireless/ath/ath11k/hal.h
@@ -664,7 +664,7 @@  struct hal_srng_config {
 };
 
 /**
- * enum hal_rx_buf_return_buf_manager
+ * enum hal_rx_buf_return_buf_manager - manager for returned rx buffers
  *
  * @HAL_RX_BUF_RBM_WBM_IDLE_BUF_LIST: Buffer returned to WBM idle buffer list
  * @HAL_RX_BUF_RBM_WBM_IDLE_DESC_LIST: Descriptor returned to WBM idle