Commit b1e8eb11 authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab Committed by Johannes Berg

mac80211: fix kernel-doc markups

Some identifiers have different names between their prototypes
and the kernel-doc markup.

Others need to be fixed, as kernel-doc markups should use this format:
        identifier - description

In the specific case of __sta_info_flush(), add a documentation
for sta_info_flush(), as this one is the one used outside
sta_info.c.
Signed-off-by: default avatarMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Reviewed-by: default avatarJohannes Berg <johannes@sipsolutions.net>
Link: https://lore.kernel.org/r/978d35eef2dc76e21c81931804e4eaefbd6d635e.1603469755.git.mchehab+huawei@kernel.orgSigned-off-by: default avatarJohannes Berg <johannes.berg@intel.com>
parent dcd479e1
...@@ -1444,7 +1444,7 @@ int cfg80211_check_station_change(struct wiphy *wiphy, ...@@ -1444,7 +1444,7 @@ int cfg80211_check_station_change(struct wiphy *wiphy,
enum cfg80211_station_type statype); enum cfg80211_station_type statype);
/** /**
* enum station_info_rate_flags - bitrate info flags * enum rate_info_flags - bitrate info flags
* *
* Used by the driver to indicate the specific rate transmission * Used by the driver to indicate the specific rate transmission
* type for 802.11n transmissions. * type for 802.11n transmissions.
...@@ -1517,7 +1517,7 @@ struct rate_info { ...@@ -1517,7 +1517,7 @@ struct rate_info {
}; };
/** /**
* enum station_info_rate_flags - bitrate info flags * enum bss_param_flags - bitrate info flags
* *
* Used by the driver to indicate the specific rate transmission * Used by the driver to indicate the specific rate transmission
* type for 802.11n transmissions. * type for 802.11n transmissions.
...@@ -6467,7 +6467,8 @@ void cfg80211_ibss_joined(struct net_device *dev, const u8 *bssid, ...@@ -6467,7 +6467,8 @@ void cfg80211_ibss_joined(struct net_device *dev, const u8 *bssid,
struct ieee80211_channel *channel, gfp_t gfp); struct ieee80211_channel *channel, gfp_t gfp);
/** /**
* cfg80211_notify_new_candidate - notify cfg80211 of a new mesh peer candidate * cfg80211_notify_new_peer_candidate - notify cfg80211 of a new mesh peer
* candidate
* *
* @dev: network device * @dev: network device
* @macaddr: the MAC address of the new candidate * @macaddr: the MAC address of the new candidate
...@@ -7606,7 +7607,7 @@ u32 cfg80211_calculate_bitrate(struct rate_info *rate); ...@@ -7606,7 +7607,7 @@ u32 cfg80211_calculate_bitrate(struct rate_info *rate);
void cfg80211_unregister_wdev(struct wireless_dev *wdev); void cfg80211_unregister_wdev(struct wireless_dev *wdev);
/** /**
* struct cfg80211_ft_event - FT Information Elements * struct cfg80211_ft_event_params - FT Information Elements
* @ies: FT IEs * @ies: FT IEs
* @ies_len: length of the FT IE in bytes * @ies_len: length of the FT IE in bytes
* @target_ap: target AP's MAC address * @target_ap: target AP's MAC address
......
...@@ -3311,7 +3311,7 @@ enum ieee80211_roc_type { ...@@ -3311,7 +3311,7 @@ enum ieee80211_roc_type {
}; };
/** /**
* enum ieee80211_reconfig_complete_type - reconfig type * enum ieee80211_reconfig_type - reconfig type
* *
* This enum is used by the reconfig_complete() callback to indicate what * This enum is used by the reconfig_complete() callback to indicate what
* reconfiguration type was completed. * reconfiguration type was completed.
...@@ -6334,7 +6334,8 @@ bool ieee80211_tx_prepare_skb(struct ieee80211_hw *hw, ...@@ -6334,7 +6334,8 @@ bool ieee80211_tx_prepare_skb(struct ieee80211_hw *hw,
int band, struct ieee80211_sta **sta); int band, struct ieee80211_sta **sta);
/** /**
* Sanity-check and parse the radiotap header of injected frames * ieee80211_parse_tx_radiotap - Sanity-check and parse the radiotap header
* of injected frames
* @skb: packet injected by userspace * @skb: packet injected by userspace
* @dev: the &struct device of this 802.11 device * @dev: the &struct device of this 802.11 device
*/ */
...@@ -6389,7 +6390,7 @@ int ieee80211_parse_p2p_noa(const struct ieee80211_p2p_noa_attr *attr, ...@@ -6389,7 +6390,7 @@ int ieee80211_parse_p2p_noa(const struct ieee80211_p2p_noa_attr *attr,
void ieee80211_update_p2p_noa(struct ieee80211_noa_data *data, u32 tsf); void ieee80211_update_p2p_noa(struct ieee80211_noa_data *data, u32 tsf);
/** /**
* ieee80211_tdls_oper - request userspace to perform a TDLS operation * ieee80211_tdls_oper_request - request userspace to perform a TDLS operation
* @vif: virtual interface * @vif: virtual interface
* @peer: the peer's destination address * @peer: the peer's destination address
* @oper: the requested TDLS operation * @oper: the requested TDLS operation
......
...@@ -785,7 +785,7 @@ int sta_info_init(struct ieee80211_local *local); ...@@ -785,7 +785,7 @@ int sta_info_init(struct ieee80211_local *local);
void sta_info_stop(struct ieee80211_local *local); void sta_info_stop(struct ieee80211_local *local);
/** /**
* sta_info_flush - flush matching STA entries from the STA table * __sta_info_flush - flush matching STA entries from the STA table
* *
* Returns the number of removed STA entries. * Returns the number of removed STA entries.
* *
...@@ -794,6 +794,13 @@ void sta_info_stop(struct ieee80211_local *local); ...@@ -794,6 +794,13 @@ void sta_info_stop(struct ieee80211_local *local);
*/ */
int __sta_info_flush(struct ieee80211_sub_if_data *sdata, bool vlans); int __sta_info_flush(struct ieee80211_sub_if_data *sdata, bool vlans);
/**
* sta_info_flush - flush matching STA entries from the STA table
*
* Returns the number of removed STA entries.
*
* @sdata: sdata to remove all stations from
*/
static inline int sta_info_flush(struct ieee80211_sub_if_data *sdata) static inline int sta_info_flush(struct ieee80211_sub_if_data *sdata)
{ {
return __sta_info_flush(sdata, false); return __sta_info_flush(sdata, false);
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment