diff options
| author | Anders Broman <anders.broman@ericsson.com> | 2010-08-29 10:47:38 +0000 |
|---|---|---|
| committer | Anders Broman <anders.broman@ericsson.com> | 2010-08-29 10:47:38 +0000 |
| commit | a009cc060501c8ce8ad679d58dfe32723f897154 (patch) | |
| tree | c315186d4c4499f605ed007825dac7e29e031cf4 /epan/ip_opts.h | |
| parent | 2f6dd574b7cb422e3862197416b80b3dbed0d06c (diff) | |
Doxygen changes.
svn path=/trunk/; revision=33990
Diffstat (limited to 'epan/ip_opts.h')
| -rw-r--r-- | epan/ip_opts.h | 27 |
1 files changed, 15 insertions, 12 deletions
diff --git a/epan/ip_opts.h b/epan/ip_opts.h index be1c55c572..dea1240fbe 100644 --- a/epan/ip_opts.h +++ b/epan/ip_opts.h @@ -26,31 +26,34 @@ #ifndef __IP_OPTS_H__ #define __IP_OPTS_H__ +/** @file + */ + typedef enum { - NO_LENGTH, /* option has no data, hence no length */ - FIXED_LENGTH, /* option always has the same length */ - VARIABLE_LENGTH /* option is variable-length - optlen is minimum */ + NO_LENGTH, /**< option has no data, hence no length */ + FIXED_LENGTH, /**< option always has the same length */ + VARIABLE_LENGTH /**< option is variable-length - optlen is minimum */ } opt_len_type; -/* Member of table of IP or TCP options. */ +/** Member of table of IP or TCP options. */ typedef struct ip_tcp_opt { - int optcode; /* code for option */ - const char *name; /* name of option */ - int *subtree_index; /* pointer to subtree index for option */ - opt_len_type len_type; /* type of option length field */ - int optlen; /* value length should be (minimum if VARIABLE) */ + int optcode; /**< code for option */ + const char *name; /**< name of option */ + int *subtree_index; /**< pointer to subtree index for option */ + opt_len_type len_type; /**< type of option length field */ + int optlen; /**< value length should be (minimum if VARIABLE) */ void (*dissect)(const struct ip_tcp_opt *, tvbuff_t *, int, guint, packet_info *, proto_tree *); - /* routine to dissect option */ + /**< routine to dissect option */ } ip_tcp_opt; -/* Routine to dissect options that work like IPv4 options, where the +/** Routine to dissect options that work like IPv4 options, where the length field in the option, if present, includes the type and length bytes. */ extern void dissect_ip_tcp_options(tvbuff_t *, int, guint, const ip_tcp_opt *, int, int, packet_info *, proto_tree *, proto_item *); -/* Routine to dissect options that work like IPv6 options, where the +/** Routine to dissect options that work like IPv6 options, where the length field in the option, if present, includes only the data, not the type and length bytes. */ extern void dissect_ipv6_options(tvbuff_t *, int, guint, |