diff mbox series

[02/22] net: mac80211: add a missing comma at kernel-doc markup

Message ID 11c1bdb861d89c93058fcfe312749b482851cbdb.1656409369.git.mchehab@kernel.org (mailing list archive)
State Awaiting Upstream
Delegated to: Netdev Maintainers
Headers show
Series Fix kernel-doc warnings at linux-next | expand

Commit Message

Mauro Carvalho Chehab June 28, 2022, 9:46 a.m. UTC
The lack of the comma makes it to not parse the function parameter:
	include/net/mac80211.h:6250: warning: Function parameter or member 'vif' not described in 'ieee80211_channel_switch_disconnect'

Fix it.

Signed-off-by: Mauro Carvalho Chehab <mchehab@kernel.org>
---

To avoid mailbombing on a large number of people, only mailing lists were C/C on the cover.
See [PATCH 00/22] at: https://lore.kernel.org/all/cover.1656409369.git.mchehab@kernel.org/

 include/net/mac80211.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Jeff Johnson June 28, 2022, 5:09 p.m. UTC | #1
On 6/28/2022 2:46 AM, Mauro Carvalho Chehab wrote:
> The lack of the comma makes it to not parse the function parameter:

nit: s/comma/colon/

> 	include/net/mac80211.h:6250: warning: Function parameter or member 'vif' not described in 'ieee80211_channel_switch_disconnect'
> 
> Fix it.
> 
> Signed-off-by: Mauro Carvalho Chehab <mchehab@kernel.org>
> ---
> 
> To avoid mailbombing on a large number of people, only mailing lists were C/C on the cover.
> See [PATCH 00/22] at: https://lore.kernel.org/all/cover.1656409369.git.mchehab@kernel.org/
> 
>   include/net/mac80211.h | 2 +-
>   1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/include/net/mac80211.h b/include/net/mac80211.h
> index 27f24ac0426d..c0557142343f 100644
> --- a/include/net/mac80211.h
> +++ b/include/net/mac80211.h
> @@ -6238,7 +6238,7 @@ void ieee80211_chswitch_done(struct ieee80211_vif *vif, bool success);
>   
>   /**
>    * ieee80211_channel_switch_disconnect - disconnect due to channel switch error
> - * @vif &struct ieee80211_vif pointer from the add_interface callback.
> + * @vif: &struct ieee80211_vif pointer from the add_interface callback.
>    * @block_tx: if %true, do not send deauth frame.
>    *
>    * Instruct mac80211 to disconnect due to a channel switch error. The channel
diff mbox series

Patch

diff --git a/include/net/mac80211.h b/include/net/mac80211.h
index 27f24ac0426d..c0557142343f 100644
--- a/include/net/mac80211.h
+++ b/include/net/mac80211.h
@@ -6238,7 +6238,7 @@  void ieee80211_chswitch_done(struct ieee80211_vif *vif, bool success);
 
 /**
  * ieee80211_channel_switch_disconnect - disconnect due to channel switch error
- * @vif &struct ieee80211_vif pointer from the add_interface callback.
+ * @vif: &struct ieee80211_vif pointer from the add_interface callback.
  * @block_tx: if %true, do not send deauth frame.
  *
  * Instruct mac80211 to disconnect due to a channel switch error. The channel