aboutsummaryrefslogtreecommitdiffstats
path: root/include/net
diff options
context:
space:
mode:
authorRandy Dunlap <randy.dunlap@oracle.com>2008-10-27 12:47:03 -0400
committerJohn W. Linville <linville@tuxdriver.com>2008-10-27 17:46:11 -0400
commitea2d8b59bc7b770fde03de2bb9b3ee46e8bdc8d5 (patch)
tree27047b27410b24f88cd8e3a84d863594e4fff98c /include/net
parentf2c2e25554991f9c17bcd24028db5e1c50ecb0ad (diff)
mac80211.h: fix kernel-doc excesses
Fix mac80211.h kernel-doc: it had some extra parameters that were no longer valid and incorrect format for a return value in 2 places. Warning(lin2628-rc2//include/net/mac80211.h:1487): Excess function parameter or struct member 'control' description in 'ieee80211_beacon_get' Warning(lin2628-rc2//include/net/mac80211.h:1596): Excess function parameter or struct member 'control' description in 'ieee80211_get_buffered_bc' Warning(lin2628-rc2//include/net/mac80211.h:1632): Excess function parameter or struct member 'rc4key' description in 'ieee80211_get_tkip_key' Warning(lin2628-rc2//include/net/mac80211.h:1735): Excess function parameter or struct member 'return' description in 'ieee80211_start_tx_ba_session' Warning(lin2628-rc2//include/net/mac80211.h:1775): Excess function parameter or struct member 'return' description in 'ieee80211_stop_tx_ba_session' Signed-off-by: Randy Dunlap <randy.dunlap@oracle.com> Acked-by: Johannes Berg <johannes@sipsolutions.net> Signed-off-by: John W. Linville <linville@tuxdriver.com>
Diffstat (limited to 'include/net')
-rw-r--r--include/net/mac80211.h11
1 files changed, 5 insertions, 6 deletions
diff --git a/include/net/mac80211.h b/include/net/mac80211.h
index d861197f83c7..8856e2d60e9f 100644
--- a/include/net/mac80211.h
+++ b/include/net/mac80211.h
@@ -1474,7 +1474,6 @@ void ieee80211_tx_status_irqsafe(struct ieee80211_hw *hw,
1474 * ieee80211_beacon_get - beacon generation function 1474 * ieee80211_beacon_get - beacon generation function
1475 * @hw: pointer obtained from ieee80211_alloc_hw(). 1475 * @hw: pointer obtained from ieee80211_alloc_hw().
1476 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf. 1476 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1477 * @control: will be filled with information needed to send this beacon.
1478 * 1477 *
1479 * If the beacon frames are generated by the host system (i.e., not in 1478 * If the beacon frames are generated by the host system (i.e., not in
1480 * hardware/firmware), the low-level driver uses this function to receive 1479 * hardware/firmware), the low-level driver uses this function to receive
@@ -1575,7 +1574,6 @@ __le16 ieee80211_generic_frame_duration(struct ieee80211_hw *hw,
1575 * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames 1574 * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames
1576 * @hw: pointer as obtained from ieee80211_alloc_hw(). 1575 * @hw: pointer as obtained from ieee80211_alloc_hw().
1577 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf. 1576 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1578 * @control: will be filled with information needed to send returned frame.
1579 * 1577 *
1580 * Function for accessing buffered broadcast and multicast frames. If 1578 * Function for accessing buffered broadcast and multicast frames. If
1581 * hardware/firmware does not implement buffering of broadcast/multicast 1579 * hardware/firmware does not implement buffering of broadcast/multicast
@@ -1623,9 +1621,8 @@ unsigned int ieee80211_hdrlen(__le16 fc);
1623 * 1621 *
1624 * @keyconf: the parameter passed with the set key 1622 * @keyconf: the parameter passed with the set key
1625 * @skb: the skb for which the key is needed 1623 * @skb: the skb for which the key is needed
1626 * @rc4key: a buffer to which the key will be written
1627 * @type: TBD 1624 * @type: TBD
1628 * @key: TBD 1625 * @key: a buffer to which the key will be written
1629 */ 1626 */
1630void ieee80211_get_tkip_key(struct ieee80211_key_conf *keyconf, 1627void ieee80211_get_tkip_key(struct ieee80211_key_conf *keyconf,
1631 struct sk_buff *skb, 1628 struct sk_buff *skb,
@@ -1726,7 +1723,8 @@ void ieee80211_iterate_active_interfaces_atomic(struct ieee80211_hw *hw,
1726 * @hw: pointer as obtained from ieee80211_alloc_hw(). 1723 * @hw: pointer as obtained from ieee80211_alloc_hw().
1727 * @ra: receiver address of the BA session recipient 1724 * @ra: receiver address of the BA session recipient
1728 * @tid: the TID to BA on. 1725 * @tid: the TID to BA on.
1729 * @return: success if addBA request was sent, failure otherwise 1726 *
1727 * Return: success if addBA request was sent, failure otherwise
1730 * 1728 *
1731 * Although mac80211/low level driver/user space application can estimate 1729 * Although mac80211/low level driver/user space application can estimate
1732 * the need to start aggregation on a certain RA/TID, the session level 1730 * the need to start aggregation on a certain RA/TID, the session level
@@ -1764,7 +1762,8 @@ void ieee80211_start_tx_ba_cb_irqsafe(struct ieee80211_hw *hw, const u8 *ra,
1764 * @ra: receiver address of the BA session recipient 1762 * @ra: receiver address of the BA session recipient
1765 * @tid: the TID to stop BA. 1763 * @tid: the TID to stop BA.
1766 * @initiator: if indicates initiator DELBA frame will be sent. 1764 * @initiator: if indicates initiator DELBA frame will be sent.
1767 * @return: error if no sta with matching da found, success otherwise 1765 *
1766 * Return: error if no sta with matching da found, success otherwise
1768 * 1767 *
1769 * Although mac80211/low level driver/user space application can estimate 1768 * Although mac80211/low level driver/user space application can estimate
1770 * the need to stop aggregation on a certain RA/TID, the session level 1769 * the need to stop aggregation on a certain RA/TID, the session level