All of lore.kernel.org
 help / color / mirror / Atom feed
From: Lee Jones <lee.jones@linaro.org>
To: kvalo@codeaurora.org, davem@davemloft.net, kuba@kernel.org
Cc: linux-kernel@vger.kernel.org, linux-wireless@vger.kernel.org,
	netdev@vger.kernel.org, Lee Jones <lee.jones@linaro.org>,
	Daniel Drake <dsd@gentoo.org>,
	Ulrich Kunitz <kune@deine-taler.de>
Subject: [PATCH 09/30] wireless: zydas: zd1211rw: zd_chip: Fix formatting
Date: Wed, 26 Aug 2020 10:33:40 +0100	[thread overview]
Message-ID: <20200826093401.1458456-10-lee.jones@linaro.org> (raw)
In-Reply-To: <20200826093401.1458456-1-lee.jones@linaro.org>

Kerneldoc expects attributes/parameters to be in '@*.: ' format and
gets confused if the variable does not follow the type/attribute
definitions.

Fixes the following W=1 kernel build warning(s):

 drivers/net/wireless/zydas/zd1211rw/zd_chip.c:1385: warning: Function parameter or member 'rx_frame' not described in 'zd_rx_rate'
 drivers/net/wireless/zydas/zd1211rw/zd_chip.c:1385: warning: Function parameter or member 'status' not described in 'zd_rx_rate'

Cc: Daniel Drake <dsd@gentoo.org>
Cc: Ulrich Kunitz <kune@deine-taler.de>
Cc: Kalle Valo <kvalo@codeaurora.org>
Cc: "David S. Miller" <davem@davemloft.net>
Cc: Jakub Kicinski <kuba@kernel.org>
Cc: linux-wireless@vger.kernel.org
Cc: netdev@vger.kernel.org
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
 drivers/net/wireless/zydas/zd1211rw/zd_chip.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/drivers/net/wireless/zydas/zd1211rw/zd_chip.c b/drivers/net/wireless/zydas/zd1211rw/zd_chip.c
index 0af4b1986e487..0216b1583b48b 100644
--- a/drivers/net/wireless/zydas/zd1211rw/zd_chip.c
+++ b/drivers/net/wireless/zydas/zd1211rw/zd_chip.c
@@ -1375,8 +1375,8 @@ static inline u8 zd_rate_from_ofdm_plcp_header(const void *rx_frame)
 
 /**
  * zd_rx_rate - report zd-rate
- * @rx_frame - received frame
- * @rx_status - rx_status as given by the device
+ * @rx_frame: received frame
+ * @rx_status: rx_status as given by the device
  *
  * This function converts the rate as encoded in the received packet to the
  * zd-rate, we are using on other places in the driver.
-- 
2.25.1


  parent reply	other threads:[~2020-08-26  9:35 UTC|newest]

Thread overview: 45+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-08-26  9:33 [PATCH 00/30] Set 3: Rid W=1 warnings in Wireless Lee Jones
2020-08-26  9:33 ` [PATCH 01/30] wireless: marvell: mwifiex: pcie: Move tables to the only place they're used Lee Jones
2020-09-01 13:06   ` [01/30] " Kalle Valo
2020-08-26  9:33 ` [PATCH 02/30] wireless: broadcom: brcmsmac: ampdu: Remove a couple set but unused variables Lee Jones
2020-08-26  9:33 ` [PATCH 03/30] wireless: intel: iwlegacy: 3945-mac: Remove all non-conformant kernel-doc headers Lee Jones
2020-08-26  9:33 ` [PATCH 04/30] wireless: intel: iwlegacy: 3945-rs: " Lee Jones
2020-08-26  9:33 ` [PATCH 05/30] wireless: intel: iwlegacy: 3945: " Lee Jones
2020-08-26  9:33 ` [PATCH 06/30] wireless: broadcom: brcmfmac: p2p: Fix a couple of function headers Lee Jones
2020-08-26  9:33 ` [PATCH 07/30] wireless: intersil: orinoco_usb: Downgrade non-conforming kernel-doc headers Lee Jones
2020-08-26  9:33 ` [PATCH 08/30] wireless: broadcom: brcmsmac: phy_cmn: Remove a unused variables 'vbat' and 'temp' Lee Jones
2020-08-26  9:33 ` Lee Jones [this message]
2020-08-26  9:33 ` [PATCH 10/30] wireless: zydas: zd1211rw: zd_mac: Add missing or incorrect function documentation Lee Jones
2020-08-26  9:33 ` [PATCH 11/30] wireless: zydas: zd1211rw: zd_chip: Correct misspelled function argument Lee Jones
2020-09-01 13:15   ` [11/30] " Kalle Valo
2020-08-26  9:33 ` [PATCH 12/30] wireless: ath: wil6210: wmi: Correct misnamed function parameter 'ptr_' Lee Jones
2020-08-26 15:56   ` Kalle Valo
2020-08-27  6:35     ` Lee Jones
2020-08-27  7:41       ` Lee Jones
2020-08-27 11:40         ` Kalle Valo
2020-08-27 12:16           ` Lee Jones
2020-08-26  9:33 ` [PATCH 13/30] wireless: broadcom: brcm80211: brcmfmac: fwsignal: Finish documenting 'brcmf_fws_mac_descriptor' Lee Jones
2020-08-26  9:33 ` [PATCH 14/30] wireless: ath: ath6kl: wmi: Remove unused variable 'rate' Lee Jones
2020-08-27 10:16   ` Kalle Valo
2020-08-26  9:33 ` [PATCH 15/30] wireless: ti: wlcore: debugfs: Remove unused variable 'res' Lee Jones
2020-08-26  9:33 ` [PATCH 16/30] wireless: rsi: rsi_91x_sdio: Fix a few kernel-doc related issues Lee Jones
2020-08-26  9:33 ` [PATCH 17/30] wireless: ath: ath9k: ar9002_initvals: Remove unused array 'ar9280PciePhy_clkreq_off_L1_9280' Lee Jones
2020-08-27 10:17   ` Kalle Valo
2020-08-26  9:33 ` [PATCH 18/30] wireless: ath: ath9k: ar9001_initvals: Remove unused array 'ar5416Bank6_9100' Lee Jones
2020-08-26  9:33 ` [PATCH 19/30] wireless: intersil: hostap: hostap_hw: Remove unused variable 'fc' Lee Jones
2020-08-26  9:33 ` [PATCH 20/30] wireless: wl3501_cs: Fix a bunch of formatting issues related to function docs Lee Jones
2020-08-26  9:33 ` [PATCH 21/30] wireless: realtek: rtw88: debug: Remove unused variables 'val' Lee Jones
2020-08-26  9:33 ` [PATCH 22/30] wireless: rsi: rsi_91x_sdio_ops: File headers are not good kernel-doc candidates Lee Jones
2020-08-26  9:33 ` [PATCH 23/30] wireless: intersil: prism54: isl_ioctl: Remove unused variable 'j' Lee Jones
2020-08-26  9:33 ` [PATCH 24/30] wireless: marvell: mwifiex: wmm: Mark 'mwifiex_1d_to_wmm_queue' as __maybe_unused Lee Jones
2020-09-01 13:16   ` [24/30] " Kalle Valo
     [not found]   ` <20200901131601.C3840C433C6@smtp.codeaurora.org>
2020-09-08  8:34     ` Lee Jones
2020-08-26  9:33 ` [PATCH 25/30] wireless: ath: ath9k: ar5008_initvals: Remove unused table entirely Lee Jones
2020-08-26  9:33 ` [PATCH 26/30] wireless: ath: ath9k: ar5008_initvals: Move ar5416Bank{0,1,2,3,7} to where they are used Lee Jones
2020-08-26  9:33 ` [PATCH 27/30] wireless: broadcom: brcm80211: phy_lcn: Remove a bunch of unused variables Lee Jones
2020-09-01 13:16   ` [27/30] brcmsmac: " Kalle Valo
2020-08-26  9:33 ` [PATCH 28/30] wireless: broadcom: brcm80211: phy_n: " Lee Jones
2020-08-26  9:34 ` [PATCH 29/30] wireless: broadcom: brcm80211: phytbl_lcn: Remove unused array 'dot11lcnphytbl_rx_gain_info_rev1' Lee Jones
2020-08-26  9:34 ` [PATCH 30/30] wireless: broadcom: brcm80211: phytbl_n: Remove a few unused arrays Lee Jones
2020-08-27 12:03 ` [PATCH 00/30] Set 3: Rid W=1 warnings in Wireless Kalle Valo
2020-08-27 12:14   ` Lee Jones

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=20200826093401.1458456-10-lee.jones@linaro.org \
    --to=lee.jones@linaro.org \
    --cc=davem@davemloft.net \
    --cc=dsd@gentoo.org \
    --cc=kuba@kernel.org \
    --cc=kune@deine-taler.de \
    --cc=kvalo@codeaurora.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-wireless@vger.kernel.org \
    --cc=netdev@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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.