summaryrefslogtreecommitdiff
path: root/epan/frame_data.h
diff options
context:
space:
mode:
authorAnders Broman <anders.broman@ericsson.com>2010-08-29 10:47:38 +0000
committerAnders Broman <anders.broman@ericsson.com>2010-08-29 10:47:38 +0000
commita009cc060501c8ce8ad679d58dfe32723f897154 (patch)
treec315186d4c4499f605ed007825dac7e29e031cf4 /epan/frame_data.h
parent2f6dd574b7cb422e3862197416b80b3dbed0d06c (diff)
downloadwireshark-a009cc060501c8ce8ad679d58dfe32723f897154.tar.gz
Doxygen changes.
svn path=/trunk/; revision=33990
Diffstat (limited to 'epan/frame_data.h')
-rw-r--r--epan/frame_data.h48
1 files changed, 24 insertions, 24 deletions
diff --git a/epan/frame_data.h b/epan/frame_data.h
index 950b90de0a..847ed1e3ff 100644
--- a/epan/frame_data.h
+++ b/epan/frame_data.h
@@ -32,7 +32,7 @@
#define PINFO_FD_NUM(pinfo) ((pinfo)->fd->num)
#define PINFO_FD_VISITED(pinfo) ((pinfo)->fd->flags.visited)
-/* XXX - some of this stuff is used only while a packet is being dissected;
+/** @todo XXX - some of this stuff is used only while a packet is being dissected;
should we keep that stuff in the "packet_info" structure, instead, to
save memory? */
@@ -40,35 +40,35 @@
it's 1-origin. In various contexts, 0 as a frame number means "frame
number unknown". */
typedef struct _frame_data {
- struct _frame_data *next; /** Next element in list */
- struct _frame_data *prev; /** Previous element in list */
- GSList *pfd; /** Per frame proto data */
- guint32 num; /** Frame number */
- guint32 pkt_len; /** Packet length */
- guint32 cap_len; /** Amount actually captured */
- guint32 cum_bytes; /** Cumulative bytes into the capture */
- gint64 file_off; /** File offset */
- guint16 subnum; /** subframe number, for protocols that require this */
- gint16 lnk_t; /** Per-packet encapsulation/data-link type */
+ struct _frame_data *next; /**< Next element in list */
+ struct _frame_data *prev; /**< Previous element in list */
+ GSList *pfd; /**< Per frame proto data */
+ guint32 num; /**< Frame number */
+ guint32 pkt_len; /**< Packet length */
+ guint32 cap_len; /**< Amount actually captured */
+ guint32 cum_bytes; /**< Cumulative bytes into the capture */
+ gint64 file_off; /**< File offset */
+ guint16 subnum; /**< subframe number, for protocols that require this */
+ gint16 lnk_t; /**< Per-packet encapsulation/data-link type */
struct {
- unsigned int passed_dfilter : 1; /** 1 = display, 0 = no display */
- unsigned int encoding : 2; /** Character encoding (ASCII, EBCDIC...) */
- unsigned int visited : 1; /** Has this packet been visited yet? 1=Yes,0=No*/
- unsigned int marked : 1; /** 1 = marked by user, 0 = normal */
- unsigned int ref_time : 1; /** 1 = marked as a reference time frame, 0 = normal */
- unsigned int ignored : 1; /** 1 = ignore this frame, 0 = normal */
+ unsigned int passed_dfilter : 1; /**< 1 = display, 0 = no display */
+ unsigned int encoding : 2; /**< Character encoding (ASCII, EBCDIC...) */
+ unsigned int visited : 1; /**< Has this packet been visited yet? 1=Yes,0=No*/
+ unsigned int marked : 1; /**< 1 = marked by user, 0 = normal */
+ unsigned int ref_time : 1; /**< 1 = marked as a reference time frame, 0 = normal */
+ unsigned int ignored : 1; /**< 1 = ignore this frame, 0 = normal */
} flags;
- const void *color_filter; /** Per-packet matching color_filter_t object */
+ const void *color_filter; /**< Per-packet matching color_filter_t object */
- nstime_t abs_ts; /** Absolute timestamp */
- nstime_t rel_ts; /** Relative timestamp (yes, it can be negative) */
- nstime_t del_dis_ts; /** Delta timestamp to previous displayed frame (yes, it can be negative) */
- nstime_t del_cap_ts; /** Delta timestamp to previous captured frame (yes, it can be negative) */
+ nstime_t abs_ts; /**< Absolute timestamp */
+ nstime_t rel_ts; /**< Relative timestamp (yes, it can be negative) */
+ nstime_t del_dis_ts; /**< Delta timestamp to previous displayed frame (yes, it can be negative) */
+ nstime_t del_cap_ts; /**< Delta timestamp to previous captured frame (yes, it can be negative) */
#ifdef NEW_PACKET_LIST
- gchar **col_text; /** The column text for some columns, see colum_utils */
- guint *col_text_len; /** The length of the column text strings in 'col_text' */
+ gchar **col_text; /**< The column text for some columns, see colum_utils */
+ guint *col_text_len; /**< The length of the column text strings in 'col_text' */
#endif
} frame_data;