aboutsummaryrefslogtreecommitdiff
path: root/src/transport/gnunet-transport-wlan-helper.c
diff options
context:
space:
mode:
authorChristian Grothoff <christian@grothoff.org>2010-09-06 20:51:27 +0000
committerChristian Grothoff <christian@grothoff.org>2010-09-06 20:51:27 +0000
commitf209d7a672de47a21bfef03d8c9249d0e6d7e71b (patch)
tree27d54555a6c6974274cee1b889efc5a77b613e52 /src/transport/gnunet-transport-wlan-helper.c
parentfba669741d6686052308b915203aca8c5788c035 (diff)
downloadgnunet-f209d7a672de47a21bfef03d8c9249d0e6d7e71b.tar.gz
gnunet-f209d7a672de47a21bfef03d8c9249d0e6d7e71b.zip
more doxygen stuff
Diffstat (limited to 'src/transport/gnunet-transport-wlan-helper.c')
-rw-r--r--src/transport/gnunet-transport-wlan-helper.c20
1 files changed, 10 insertions, 10 deletions
diff --git a/src/transport/gnunet-transport-wlan-helper.c b/src/transport/gnunet-transport-wlan-helper.c
index af49f9833..4edbb6b70 100644
--- a/src/transport/gnunet-transport-wlan-helper.c
+++ b/src/transport/gnunet-transport-wlan-helper.c
@@ -177,11 +177,11 @@ int flagVerbose = 0;
177 177
178/** 178/**
179 * ieee80211_radiotap_iterator_init - radiotap parser iterator initialization 179 * ieee80211_radiotap_iterator_init - radiotap parser iterator initialization
180 * @iterator: radiotap_iterator to initialize 180 * @param iterator: radiotap_iterator to initialize
181 * @radiotap_header: radiotap header to parse 181 * @param radiotap_header: radiotap header to parse
182 * @max_length: total length we can parse into (eg, whole packet length) 182 * @param max_length: total length we can parse into (eg, whole packet length)
183 * 183 *
184 * Returns: 0 or a negative error code if there is a problem. 184 * @return 0 or a negative error code if there is a problem.
185 * 185 *
186 * This function initializes an opaque iterator struct which can then 186 * This function initializes an opaque iterator struct which can then
187 * be passed to ieee80211_radiotap_iterator_next() to visit every radiotap 187 * be passed to ieee80211_radiotap_iterator_next() to visit every radiotap
@@ -194,9 +194,9 @@ int flagVerbose = 0;
194 * checking for a good 0 return code. Then loop calling 194 * checking for a good 0 return code. Then loop calling
195 * __ieee80211_radiotap_iterator_next()... it returns either 0, 195 * __ieee80211_radiotap_iterator_next()... it returns either 0,
196 * -ENOENT if there are no more args to parse, or -EINVAL if there is a problem. 196 * -ENOENT if there are no more args to parse, or -EINVAL if there is a problem.
197 * The iterator's @this_arg member points to the start of the argument 197 * The iterator's this_arg member points to the start of the argument
198 * associated with the current argument index that is present, which can be 198 * associated with the current argument index that is present, which can be
199 * found in the iterator's @this_arg_index member. This arg index corresponds 199 * found in the iterator's this_arg_index member. This arg index corresponds
200 * to the IEEE80211_RADIOTAP_... defines. 200 * to the IEEE80211_RADIOTAP_... defines.
201 * 201 *
202 * Radiotap header length: 202 * Radiotap header length:
@@ -263,16 +263,16 @@ int ieee80211_radiotap_iterator_init(
263 263
264/** 264/**
265 * ieee80211_radiotap_iterator_next - return next radiotap parser iterator arg 265 * ieee80211_radiotap_iterator_next - return next radiotap parser iterator arg
266 * @iterator: radiotap_iterator to move to next arg (if any) 266 * @param iterator: radiotap_iterator to move to next arg (if any)
267 * 267 *
268 * Returns: 0 if there is an argument to handle, 268 * @eturn 0 if there is an argument to handle,
269 * -ENOENT if there are no more args or -EINVAL 269 * -ENOENT if there are no more args or -EINVAL
270 * if there is something else wrong. 270 * if there is something else wrong.
271 * 271 *
272 * This function provides the next radiotap arg index (IEEE80211_RADIOTAP_*) 272 * This function provides the next radiotap arg index (IEEE80211_RADIOTAP_*)
273 * in @this_arg_index and sets @this_arg to point to the 273 * in this_arg_index and sets this_arg to point to the
274 * payload for the field. It takes care of alignment handling and extended 274 * payload for the field. It takes care of alignment handling and extended
275 * present fields. @this_arg can be changed by the caller (eg, 275 * present fields. this_arg can be changed by the caller (eg,
276 * incremented to move inside a compound argument like 276 * incremented to move inside a compound argument like
277 * IEEE80211_RADIOTAP_CHANNEL). The args pointed to are in 277 * IEEE80211_RADIOTAP_CHANNEL). The args pointed to are in
278 * little-endian format whatever the endianess of your CPU. 278 * little-endian format whatever the endianess of your CPU.