diff options
author | Ben Hutchings <bhutchings@solarflare.com> | 2012-07-10 06:55:09 -0400 |
---|---|---|
committer | David S. Miller <davem@davemloft.net> | 2012-07-11 02:13:45 -0400 |
commit | 2c53040f018b6c36a46eec75b9b937aaa5f78e6d (patch) | |
tree | f77d987c380f78daf40838688a5f49bb4ab065ee /net/mac80211 | |
parent | a55b138b1da3d25c04f66f8df03d659dfd46c950 (diff) |
net: Fix (nearly-)kernel-doc comments for various functions
Fix incorrect start markers, wrapped summary lines, missing section
breaks, incorrect separators, and some name mismatches.
Signed-off-by: Ben Hutchings <bhutchings@solarflare.com>
Signed-off-by: David S. Miller <davem@davemloft.net>
Diffstat (limited to 'net/mac80211')
-rw-r--r-- | net/mac80211/mesh.c | 2 | ||||
-rw-r--r-- | net/mac80211/mesh_hwmp.c | 7 | ||||
-rw-r--r-- | net/mac80211/mesh_pathtbl.c | 4 | ||||
-rw-r--r-- | net/mac80211/mesh_plink.c | 5 | ||||
-rw-r--r-- | net/mac80211/rx.c | 2 |
5 files changed, 12 insertions, 8 deletions
diff --git a/net/mac80211/mesh.c b/net/mac80211/mesh.c index 764593d65fc3..6fac18c0423f 100644 --- a/net/mac80211/mesh.c +++ b/net/mac80211/mesh.c | |||
@@ -133,7 +133,7 @@ bool mesh_peer_accepts_plinks(struct ieee802_11_elems *ie) | |||
133 | } | 133 | } |
134 | 134 | ||
135 | /** | 135 | /** |
136 | * mesh_accept_plinks_update: update accepting_plink in local mesh beacons | 136 | * mesh_accept_plinks_update - update accepting_plink in local mesh beacons |
137 | * | 137 | * |
138 | * @sdata: mesh interface in which mesh beacons are going to be updated | 138 | * @sdata: mesh interface in which mesh beacons are going to be updated |
139 | */ | 139 | */ |
diff --git a/net/mac80211/mesh_hwmp.c b/net/mac80211/mesh_hwmp.c index fb7b6a11d0ba..494bc39f61a4 100644 --- a/net/mac80211/mesh_hwmp.c +++ b/net/mac80211/mesh_hwmp.c | |||
@@ -1054,12 +1054,15 @@ enddiscovery: | |||
1054 | kfree(preq_node); | 1054 | kfree(preq_node); |
1055 | } | 1055 | } |
1056 | 1056 | ||
1057 | /* mesh_nexthop_resolve - lookup next hop for given skb and start path | 1057 | /** |
1058 | * discovery if no forwarding information is found. | 1058 | * mesh_nexthop_resolve - lookup next hop; conditionally start path discovery |
1059 | * | 1059 | * |
1060 | * @skb: 802.11 frame to be sent | 1060 | * @skb: 802.11 frame to be sent |
1061 | * @sdata: network subif the frame will be sent through | 1061 | * @sdata: network subif the frame will be sent through |
1062 | * | 1062 | * |
1063 | * Lookup next hop for given skb and start path discovery if no | ||
1064 | * forwarding information is found. | ||
1065 | * | ||
1063 | * Returns: 0 if the next hop was found and -ENOENT if the frame was queued. | 1066 | * Returns: 0 if the next hop was found and -ENOENT if the frame was queued. |
1064 | * skb is freeed here if no mpath could be allocated. | 1067 | * skb is freeed here if no mpath could be allocated. |
1065 | */ | 1068 | */ |
diff --git a/net/mac80211/mesh_pathtbl.c b/net/mac80211/mesh_pathtbl.c index c9ae931dd693..075bc535c601 100644 --- a/net/mac80211/mesh_pathtbl.c +++ b/net/mac80211/mesh_pathtbl.c | |||
@@ -778,7 +778,7 @@ static void __mesh_path_del(struct mesh_table *tbl, struct mpath_node *node) | |||
778 | /** | 778 | /** |
779 | * mesh_path_flush_by_nexthop - Deletes mesh paths if their next hop matches | 779 | * mesh_path_flush_by_nexthop - Deletes mesh paths if their next hop matches |
780 | * | 780 | * |
781 | * @sta - mesh peer to match | 781 | * @sta: mesh peer to match |
782 | * | 782 | * |
783 | * RCU notes: this function is called when a mesh plink transitions from | 783 | * RCU notes: this function is called when a mesh plink transitions from |
784 | * PLINK_ESTAB to any other state, since PLINK_ESTAB state is the only one that | 784 | * PLINK_ESTAB to any other state, since PLINK_ESTAB state is the only one that |
@@ -833,7 +833,7 @@ static void table_flush_by_iface(struct mesh_table *tbl, | |||
833 | * | 833 | * |
834 | * This function deletes both mesh paths as well as mesh portal paths. | 834 | * This function deletes both mesh paths as well as mesh portal paths. |
835 | * | 835 | * |
836 | * @sdata - interface data to match | 836 | * @sdata: interface data to match |
837 | * | 837 | * |
838 | */ | 838 | */ |
839 | void mesh_path_flush_by_iface(struct ieee80211_sub_if_data *sdata) | 839 | void mesh_path_flush_by_iface(struct ieee80211_sub_if_data *sdata) |
diff --git a/net/mac80211/mesh_plink.c b/net/mac80211/mesh_plink.c index a1dbd1540276..9ad74dd87a7b 100644 --- a/net/mac80211/mesh_plink.c +++ b/net/mac80211/mesh_plink.c | |||
@@ -99,7 +99,7 @@ static struct sta_info *mesh_plink_alloc(struct ieee80211_sub_if_data *sdata, | |||
99 | return sta; | 99 | return sta; |
100 | } | 100 | } |
101 | 101 | ||
102 | /* | 102 | /** |
103 | * mesh_set_ht_prot_mode - set correct HT protection mode | 103 | * mesh_set_ht_prot_mode - set correct HT protection mode |
104 | * | 104 | * |
105 | * Section 9.23.3.5 of IEEE 80211-2012 describes the protection rules for HT | 105 | * Section 9.23.3.5 of IEEE 80211-2012 describes the protection rules for HT |
@@ -320,7 +320,8 @@ static int mesh_plink_frame_tx(struct ieee80211_sub_if_data *sdata, | |||
320 | return 0; | 320 | return 0; |
321 | } | 321 | } |
322 | 322 | ||
323 | /* mesh_peer_init - initialize new mesh peer and return resulting sta_info | 323 | /** |
324 | * mesh_peer_init - initialize new mesh peer and return resulting sta_info | ||
324 | * | 325 | * |
325 | * @sdata: local meshif | 326 | * @sdata: local meshif |
326 | * @addr: peer's address | 327 | * @addr: peer's address |
diff --git a/net/mac80211/rx.c b/net/mac80211/rx.c index 839cac8fab57..67edd69e8421 100644 --- a/net/mac80211/rx.c +++ b/net/mac80211/rx.c | |||
@@ -94,7 +94,7 @@ ieee80211_rx_radiotap_len(struct ieee80211_local *local, | |||
94 | return len; | 94 | return len; |
95 | } | 95 | } |
96 | 96 | ||
97 | /* | 97 | /** |
98 | * ieee80211_add_rx_radiotap_header - add radiotap header | 98 | * ieee80211_add_rx_radiotap_header - add radiotap header |
99 | * | 99 | * |
100 | * add a radiotap header containing all the fields which the hardware provided. | 100 | * add a radiotap header containing all the fields which the hardware provided. |