osmith
/
wireshark
forked from osmocom/wireshark
1
0
Fork 0
Code Pull Requests Releases Wiki Activity

packet-ieee80211-radiotap-iter.h: Try to fix doxygen warnings. 

Change-Id: Icca2505f933a43b218043055201b00a47e77bef8
Reviewed-on: https://code.wireshark.org/review/33883
Petri-Dish: Anders Broman <a.broman58@gmail.com>
Tested-by: Petri Dish Buildbot
Reviewed-by: Anders Broman <a.broman58@gmail.com>
This commit is contained in:
Anders Broman 2019-07-10 10:11:27 +02:00 committed by Anders Broman
parent 29698e9d12
commit 7599f7bb11
1 changed files with 21 additions and 40 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

61
epan/dissectors/packet-ieee80211-radiotap-iter.h
View File

@ -42,58 +42,39 @@ struct ieee80211_radiotap_vendor_namespaces {
/**
* struct ieee80211_radiotap_iterator - tracks walk thru present radiotap args
* @this_arg_index: index of current arg, valid after each successful call
* to ieee80211_radiotap_iterator_next()
* @this_arg: pointer to current radiotap arg; it is valid after each
* call to ieee80211_radiotap_iterator_next() but also after
* ieee80211_radiotap_iterator_init() where it will point to
* the beginning of the actual data portion
* @this_arg_size: length of the current arg, for convenience
* @current_namespace: pointer to the current namespace definition
* (or internally %NULL if the current namespace is unknown)
* @is_radiotap_ns: indicates whether the current namespace is the default
* radiotap namespace or not
*
* @overrides: override standard radiotap fields
* @n_overrides: number of overrides
*
* @_rtheader: pointer to the radiotap header we are walking through
* @_max_length: length of radiotap header in cpu byte ordering
* @_arg_index: next argument index
* @_arg: next argument pointer
* @_next_bitmap: internal pointer to next present u32
* @_bitmap_shifter: internal shifter for curr u32 bitmap, b0 set == arg present
* @_vns: vendor namespace definitions
* @_next_ns_data: beginning of the next namespace's data
* @_reset_on_ext: internal; reset the arg index to 0 when going to the
* next bitmap word
*
* Describes the radiotap parser state. Fields prefixed with an underscore
* must not be used by users of the parser, only by the parser internally.
*/
struct ieee80211_radiotap_iterator {
struct ieee80211_radiotap_header *_rtheader;
const struct ieee80211_radiotap_vendor_namespaces *_vns;
const struct ieee80211_radiotap_namespace *current_namespace;
struct ieee80211_radiotap_header *_rtheader; /**< pointer to the radiotap header we are walking through */
const struct ieee80211_radiotap_vendor_namespaces *_vns; /**< vendor namespace definitions*/
const struct ieee80211_radiotap_namespace *current_namespace; /**< pointer to the current namespace definition (or internally
%NULL if the current namespace is unknown)*/
unsigned char *_arg, *_next_ns_data;
guint32 *_next_bitmap;
unsigned char *_arg, *_next_ns_data; /**< beginning of the next namespace's data */
guint32 *_next_bitmap; /**< internal pointer to next present u32 */
unsigned char *this_arg;
unsigned char *this_arg; /**< pointer to current radiotap arg; it is valid after each call
to ieee80211_radiotap_iterator_next() but also after
ieee80211_radiotap_iterator_init() where it will point to
the beginning of the actual data portion */
#ifdef RADIOTAP_SUPPORT_OVERRIDES
const struct radiotap_override *overrides;
int n_overrides;
const struct radiotap_override *overrides; /**< override standard radiotap fields */
int n_overrides; /**< number of overrides */
#endif
int this_arg_index;
int this_arg_size;
int this_arg_index; /**< index of current arg, valid after each successful call to
ieee80211_radiotap_iterator_next() */
int this_arg_size; /**< length of the current arg, for convenience*/
int is_radiotap_ns;
int is_radiotap_ns; /**< indicates whether the current namespace is the default radiotap
namespace or not*/
int _max_length;
int _arg_index;
guint32 _bitmap_shifter;
int _reset_on_ext;
int _max_length; /**< length of radiotap header in cpu byte ordering */
int _arg_index; /**< next argument index */
guint32 _bitmap_shifter; /**< internal shifter for curr u32 bitmap, b0 set == arg present */
int _reset_on_ext; /**< internal; reset the arg index to 0 when going to the next bitmap word */
};
extern int ieee80211_radiotap_iterator_init(