diff mbox series

[04/11] net: broadcom: brcmfmac: Demote non-compliant kernel-doc headers

Message ID 20210517050141.61488-5-shenyang39@huawei.com
State New
Headers show
Series [01/11] net: ath: ath5k: Fix wrong function name in comments | expand

Commit Message

Yang Shen May 17, 2021, 5:01 a.m. UTC
Fixes the following W=1 kernel build warning(s):

 drivers/net/wireless/broadcom/brcm80211/brcmfmac/p2p.c:2040: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
 drivers/net/wireless/broadcom/brcm80211/brcmfmac/sdio.c:1295: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst

Cc: Franky Lin <franky.lin@broadcom.com>
Cc: Hante Meuleman <hante.meuleman@broadcom.com>
Signed-off-by: Yang Shen <shenyang39@huawei.com>
---
 drivers/net/wireless/broadcom/brcm80211/brcmfmac/p2p.c  | 2 +-
 drivers/net/wireless/broadcom/brcm80211/brcmfmac/sdio.c | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

Comments

Arend Van Spriel May 19, 2021, 12:41 p.m. UTC | #1
On 17-05-2021 07:01, Yang Shen wrote:
> Fixes the following W=1 kernel build warning(s):

> 

>   drivers/net/wireless/broadcom/brcm80211/brcmfmac/p2p.c:2040: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst

>   drivers/net/wireless/broadcom/brcm80211/brcmfmac/sdio.c:1295: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst


Acked-by: Arend van Spriel <arend.vanspriel@broadcom.com>

> Cc: Franky Lin <franky.lin@broadcom.com>

> Cc: Hante Meuleman <hante.meuleman@broadcom.com>

> Signed-off-by: Yang Shen <shenyang39@huawei.com>

> ---

>   drivers/net/wireless/broadcom/brcm80211/brcmfmac/p2p.c  | 2 +-

>   drivers/net/wireless/broadcom/brcm80211/brcmfmac/sdio.c | 2 +-

>   2 files changed, 2 insertions(+), 2 deletions(-)
Kalle Valo June 15, 2021, 10:37 a.m. UTC | #2
Yang Shen <shenyang39@huawei.com> wrote:

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

> 

>  drivers/net/wireless/broadcom/brcm80211/brcmfmac/p2p.c:2040: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst

>  drivers/net/wireless/broadcom/brcm80211/brcmfmac/sdio.c:1295: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst

> 

> Cc: Franky Lin <franky.lin@broadcom.com>

> Cc: Hante Meuleman <hante.meuleman@broadcom.com>

> Signed-off-by: Yang Shen <shenyang39@huawei.com>

> Acked-by: Arend van Spriel <arend.vanspriel@broadcom.com>


Patch applied to wireless-drivers-next.git, thanks.

ea3f903caea0 brcmfmac: Demote non-compliant kernel-doc headers

-- 
https://patchwork.kernel.org/project/linux-wireless/patch/20210517050141.61488-5-shenyang39@huawei.com/

https://wireless.wiki.kernel.org/en/developers/documentation/submittingpatches
diff mbox series

Patch

diff --git a/drivers/net/wireless/broadcom/brcm80211/brcmfmac/p2p.c b/drivers/net/wireless/broadcom/brcm80211/brcmfmac/p2p.c
index 34cd8a7401fe..9ac0d8c73d5a 100644
--- a/drivers/net/wireless/broadcom/brcm80211/brcmfmac/p2p.c
+++ b/drivers/net/wireless/broadcom/brcm80211/brcmfmac/p2p.c
@@ -2037,7 +2037,7 @@  static void brcmf_p2p_get_current_chanspec(struct brcmf_p2p_info *p2p,
 }
 
 /**
- * Change a P2P Role.
+ * brcmf_p2p_ifchange - Change a P2P Role.
  * @cfg: driver private data for cfg80211 interface.
  * @if_type: interface type.
  * Returns 0 if success.
diff --git a/drivers/net/wireless/broadcom/brcm80211/brcmfmac/sdio.c b/drivers/net/wireless/broadcom/brcm80211/brcmfmac/sdio.c
index 16ed325795a8..d1dda851e176 100644
--- a/drivers/net/wireless/broadcom/brcm80211/brcmfmac/sdio.c
+++ b/drivers/net/wireless/broadcom/brcm80211/brcmfmac/sdio.c
@@ -1291,7 +1291,7 @@  static void brcmf_sdio_free_glom(struct brcmf_sdio *bus)
 	}
 }
 
-/**
+/*
  * brcmfmac sdio bus specific header
  * This is the lowest layer header wrapped on the packets transmitted between
  * host and WiFi dongle which contains information needed for SDIO core and