aboutsummaryrefslogtreecommitdiffstats
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
parent2f6dd574b7cb422e3862197416b80b3dbed0d06c (diff)
Doxygen changes.
svn path=/trunk/; revision=33990
-rw-r--r--epan/camel-persistentdata.h42
-rw-r--r--epan/column_info.h162
-rw-r--r--epan/crypt/airpdcap_int.h2
-rw-r--r--epan/crypt/crypt-md5.h4
-rw-r--r--epan/dfilter/syntax-tree.h5
-rw-r--r--epan/emem.h120
-rw-r--r--epan/epan.h35
-rw-r--r--epan/frame_data.h48
-rw-r--r--epan/ip_opts.h27
-rw-r--r--epan/ipv6-utils.h2
-rw-r--r--epan/nstime.h25
-rw-r--r--epan/oids.h2
-rw-r--r--epan/prefs-int.h48
-rw-r--r--epan/proto.h4
-rw-r--r--epan/stats_tree_priv.h58
-rw-r--r--epan/strutil.h17
-rw-r--r--epan/tfs.h10
-rw-r--r--epan/tvbuff.h19
-rw-r--r--epan/wslua/init_wslua.h4
-rw-r--r--epan/xdlc.h82
20 files changed, 389 insertions, 327 deletions
diff --git a/epan/camel-persistentdata.h b/epan/camel-persistentdata.h
index c90ed72aae..64c64eadd0 100644
--- a/epan/camel-persistentdata.h
+++ b/epan/camel-persistentdata.h
@@ -37,7 +37,9 @@
extern "C" {
#endif /* __cplusplus */
-#define NB_CAMELSRT_CATEGORY 9+1 /* Number of type of message */
+/** @file
+*/
+#define NB_CAMELSRT_CATEGORY 9+1 /**< Number of type of message */
/* for example TC_BEGIN with InitalDP, and TC_CONT with RequestReportBCSMEvent
is a category, we want to measure the delay between the two messages */
@@ -56,37 +58,37 @@ extern "C" {
WS_VAR_IMPORT const value_string camelSRTtype_naming[];
-/* If we have a request message and its response,
+/** If we have a request message and its response,
(eg: ApplyCharging, ApplyChargingReport)
the frames numbers are stored in this structure */
struct camelsrt_category_t {
- guint32 req_num; /* frame number request seen */
- guint32 rsp_num; /* frame number response seen */
- nstime_t req_time; /* arrival time of request */
- gboolean responded; /* true, if request has been responded */
+ guint32 req_num; /**< frame number request seen */
+ guint32 rsp_num; /**< frame number response seen */
+ nstime_t req_time; /**< arrival time of request */
+ gboolean responded; /**< true, if request has been responded */
};
-/* List of stored parameters for a Camel dialogue
+/** List of stored parameters for a Camel dialogue
All this parameters are linked to the hash table key below (use of Tid)
In case of same Tid reused, the Camel parameters are chained.
The right dialogue will be identified with the arrival time of the InitialDP */
struct camelsrt_call_t {
- guint32 session_id; /* Identify the session, with an internal number */
+ guint32 session_id; /**< Identify the session, with an internal number */
struct tcaphash_context_t * tcap_context;
struct camelsrt_category_t category[NB_CAMELSRT_CATEGORY];
};
-/* The Key for the hash table is the TCAP origine transaction identifier
+/** The Key for the hash table is the TCAP origine transaction identifier
of the TC_BEGIN containing the InitialDP */
struct camelsrt_call_info_key_t {
guint32 SessionIdKey;
};
-/* Info for a couple of messages (or category)
+/** Info for a couple of messages (or category)
The request must be available, not duplicated,
and once the corresponding response received,
we can deduce the Delta Time between Request/response */
@@ -99,20 +101,34 @@ struct camelsrt_msginfo_t {
nstime_t delta_time;
};
-/* List of infos to store for the analyse */
+/** List of infos to store for the analyse */
struct camelsrt_info_t {
guint32 tcap_session_id;
void * tcap_context;
- guint8 opcode; /* operation code of message received */
- guint8 bool_msginfo[NB_CAMELSRT_CATEGORY]; /* category for the received message */
+ guint8 opcode; /**< operation code of message received */
+ guint8 bool_msginfo[NB_CAMELSRT_CATEGORY]; /**< category for the received message */
struct camelsrt_msginfo_t msginfo[NB_CAMELSRT_CATEGORY];
};
+/**
+ * Routine called when the TAP is initialized.
+ * so hash table are (re)created
+ */
void camelsrt_init_routine(void);
+/**
+ * Initialize the Message Info used by the main dissector
+ * Data are linked to a TCAP transaction
+ */
struct camelsrt_info_t * camelsrt_razinfo(void);
+/**
+ * Service Response Time analyze, called just after the camel dissector
+ * According to the camel operation, we
+ * - open/close a context for the camel session
+ * - look for a request, or look for the corresponding response
+ */
void camelsrt_call_matching(tvbuff_t *tvb,
packet_info * pinfo _U_,
proto_tree *tree,
diff --git a/epan/column_info.h b/epan/column_info.h
index faa8b6cdd7..91489c113a 100644
--- a/epan/column_info.h
+++ b/epan/column_info.h
@@ -31,33 +31,39 @@
extern "C" {
#endif /* __cplusplus */
+/** @file
+ * Column info.
+ */
+
#define COL_MAX_LEN 256
#define COL_MAX_INFO_LEN 4096
+/** Column expression */
typedef struct {
- const gchar **col_expr; /* Filter expression */
- gchar **col_expr_val; /* Value for filter expression */
+ const gchar **col_expr; /**< Filter expression */
+ gchar **col_expr_val; /**< Value for filter expression */
} col_expr_t;
+/** Coulmn info */
typedef struct _column_info {
- gint num_cols; /* Number of columns */
- gint *col_fmt; /* Format of column */
- gboolean **fmt_matx; /* Specifies which formats apply to a column */
- gint *col_first; /* First column number with a given format */
- gint *col_last; /* Last column number with a given format */
- gchar **col_title; /* Column titles */
- gchar **col_custom_field; /* Custom column field */
- gint *col_custom_field_id; /* Custom column field id*/
- struct _dfilter_t **col_custom_dfilter; /* Compiled custom column field */
- const gchar **col_data; /* Column data */
- gchar **col_buf; /* Buffer into which to copy data for column */
- int *col_fence; /* Stuff in column buffer before this index is immutable */
- col_expr_t col_expr; /* Column expressions and values */
- gboolean writable; /* Are we still writing to the columns? */
- gboolean columns_changed; /* Have the columns been changed in the prefs? */
+ gint num_cols; /**< Number of columns */
+ gint *col_fmt; /**< Format of column */
+ gboolean **fmt_matx; /**< Specifies which formats apply to a column */
+ gint *col_first; /**< First column number with a given format */
+ gint *col_last; /**< Last column number with a given format */
+ gchar **col_title; /**< Column titles */
+ gchar **col_custom_field; /**< Custom column field */
+ gint *col_custom_field_id; /**< Custom column field id*/
+ struct _dfilter_t **col_custom_dfilter; /**< Compiled custom column field */
+ const gchar **col_data; /**< Column data */
+ gchar **col_buf; /**< Buffer into which to copy data for column */
+ int *col_fence; /**< Stuff in column buffer before this index is immutable */
+ col_expr_t col_expr; /**< Column expressions and values */
+ gboolean writable; /**< writable or not @todo Are we still writing to the columns? */
+ gboolean columns_changed; /**< Have the columns been changed in the prefs? */
} column_info;
-/*
+/**
* All of the possible columns in summary listing.
*
* NOTE1: The entries MUST remain in this order, or else you need to reorder
@@ -67,66 +73,66 @@ typedef struct _column_info {
* dlist[] array remains in alphabetical order!
*/
enum {
- COL_8021Q_VLAN_ID, /* 0) 802.1Q vlan ID */
- COL_ABS_DATE_TIME, /* 1) Absolute date and time */
- COL_ABS_TIME, /* 2) Absolute time */
- COL_CIRCUIT_ID, /* 3) Circuit ID */
- COL_DSTIDX, /* 4) !! DEPRECATED !! - Dst port idx - Cisco MDS-specific */
- COL_SRCIDX, /* 5) !! DEPRECATED !! - Src port idx - Cisco MDS-specific */
- COL_VSAN, /* 6) VSAN - Cisco MDS-specific */
- COL_CUMULATIVE_BYTES, /* 7) Cumulative number of bytes */
- COL_CUSTOM, /* 8) Custom column (any filter name's contents) */
- COL_DCE_CALL, /* 9) DCE/RPC connection oriented call id OR datagram sequence number */
- COL_DCE_CTX, /* 10) !! DEPRECATED !! - DCE/RPC connection oriented context id */
- COL_DELTA_TIME, /* 11) Delta time */
- COL_DELTA_CONV_TIME,/* 12) Delta time to last frame in conversation */
- COL_DELTA_TIME_DIS, /* 13) Delta time displayed*/
- COL_RES_DST, /* 14) Resolved dest */
- COL_UNRES_DST, /* 15) Unresolved dest */
- COL_RES_DST_PORT, /* 16) Resolved dest port */
- COL_UNRES_DST_PORT, /* 17) Unresolved dest port */
- COL_DEF_DST, /* 18) Destination address */
- COL_DEF_DST_PORT, /* 19) Destination port */
- COL_EXPERT, /* 20) Expert Info */
- COL_IF_DIR, /* 21) FW-1 monitor interface/direction */
- COL_OXID, /* 22) !! DEPRECATED !! - Fibre Channel OXID */
- COL_RXID, /* 23) !! DEPRECATED !! - Fibre Channel RXID */
- COL_FR_DLCI, /* 24) !! DEPRECATED !! - Frame Relay DLCI */
- COL_FREQ_CHAN, /* 25) IEEE 802.11 (and WiMax?) - Channel */
- COL_BSSGP_TLLI, /* 26) !! DEPRECATED !! - GPRS BSSGP IE TLLI */
- COL_HPUX_DEVID, /* 27) !! DEPRECATED !! - HP-UX Nettl Device ID */
- COL_HPUX_SUBSYS, /* 28) !! DEPRECATED !! - HP-UX Nettl Subsystem */
- COL_DEF_DL_DST, /* 29) Data link layer dest address */
- COL_DEF_DL_SRC, /* 30) Data link layer source address */
- COL_RES_DL_DST, /* 31) Resolved DL dest */
- COL_UNRES_DL_DST, /* 32) Unresolved DL dest */
- COL_RES_DL_SRC, /* 33) Resolved DL source */
- COL_UNRES_DL_SRC, /* 34) Unresolved DL source */
- COL_RSSI, /* 35) IEEE 802.11 - received signal strength */
- COL_TX_RATE, /* 36) IEEE 802.11 - TX rate in Mbps */
- COL_DSCP_VALUE, /* 37) IP DSCP Value */
- COL_INFO, /* 38) Description */
- COL_COS_VALUE, /* 39) !! DEPRECATED !! - L2 COS Value */
- COL_RES_NET_DST, /* 40) Resolved net dest */
- COL_UNRES_NET_DST, /* 41) Unresolved net dest */
- COL_RES_NET_SRC, /* 42) Resolved net source */
- COL_UNRES_NET_SRC, /* 43) Unresolved net source */
- COL_DEF_NET_DST, /* 44) Network layer dest address */
- COL_DEF_NET_SRC, /* 45) Network layer source address */
- COL_NUMBER, /* 46) Packet list item number */
- COL_PACKET_LENGTH, /* 47) Packet length in bytes */
- COL_PROTOCOL, /* 48) Protocol */
- COL_REL_TIME, /* 49) Relative time */
- COL_REL_CONV_TIME, /* 50) !! DEPRECATED !! - Relative time to beginning of conversation */
- COL_DEF_SRC, /* 51) Source address */
- COL_DEF_SRC_PORT, /* 52) Source port */
- COL_RES_SRC, /* 53) Resolved source */
- COL_UNRES_SRC, /* 54) Unresolved source */
- COL_RES_SRC_PORT, /* 55) Resolved source port */
- COL_UNRES_SRC_PORT, /* 56) Unresolved source port */
- COL_TEI, /* 57) Q.921 TEI */
- COL_CLS_TIME, /* 58) Command line-specified time (default relative) */
- NUM_COL_FMTS /* 59) Should always be last */
+ COL_8021Q_VLAN_ID, /**< 0) 802.1Q vlan ID */
+ COL_ABS_DATE_TIME, /**< 1) Absolute date and time */
+ COL_ABS_TIME, /**< 2) Absolute time */
+ COL_CIRCUIT_ID, /**< 3) Circuit ID */
+ COL_DSTIDX, /**< 4) !! DEPRECATED !! - Dst port idx - Cisco MDS-specific */
+ COL_SRCIDX, /**< 5) !! DEPRECATED !! - Src port idx - Cisco MDS-specific */
+ COL_VSAN, /**< 6) VSAN - Cisco MDS-specific */
+ COL_CUMULATIVE_BYTES, /**< 7) Cumulative number of bytes */
+ COL_CUSTOM, /**< 8) Custom column (any filter name's contents) */
+ COL_DCE_CALL, /**< 9) DCE/RPC connection oriented call id OR datagram sequence number */
+ COL_DCE_CTX, /**< 10) !! DEPRECATED !! - DCE/RPC connection oriented context id */
+ COL_DELTA_TIME, /**< 11) Delta time */
+ COL_DELTA_CONV_TIME,/**< 12) Delta time to last frame in conversation */
+ COL_DELTA_TIME_DIS, /**< 13) Delta time displayed*/
+ COL_RES_DST, /**< 14) Resolved dest */
+ COL_UNRES_DST, /**< 15) Unresolved dest */
+ COL_RES_DST_PORT, /**< 16) Resolved dest port */
+ COL_UNRES_DST_PORT, /**< 17) Unresolved dest port */
+ COL_DEF_DST, /**< 18) Destination address */
+ COL_DEF_DST_PORT, /**< 19) Destination port */
+ COL_EXPERT, /**< 20) Expert Info */
+ COL_IF_DIR, /**< 21) FW-1 monitor interface/direction */
+ COL_OXID, /**< 22) !! DEPRECATED !! - Fibre Channel OXID */
+ COL_RXID, /**< 23) !! DEPRECATED !! - Fibre Channel RXID */
+ COL_FR_DLCI, /**< 24) !! DEPRECATED !! - Frame Relay DLCI */
+ COL_FREQ_CHAN, /**< 25) IEEE 802.11 (and WiMax?) - Channel */
+ COL_BSSGP_TLLI, /**< 26) !! DEPRECATED !! - GPRS BSSGP IE TLLI */
+ COL_HPUX_DEVID, /**< 27) !! DEPRECATED !! - HP-UX Nettl Device ID */
+ COL_HPUX_SUBSYS, /**< 28) !! DEPRECATED !! - HP-UX Nettl Subsystem */
+ COL_DEF_DL_DST, /**< 29) Data link layer dest address */
+ COL_DEF_DL_SRC, /**< 30) Data link layer source address */
+ COL_RES_DL_DST, /**< 31) Resolved DL dest */
+ COL_UNRES_DL_DST, /**< 32) Unresolved DL dest */
+ COL_RES_DL_SRC, /**< 33) Resolved DL source */
+ COL_UNRES_DL_SRC, /**< 34) Unresolved DL source */
+ COL_RSSI, /**< 35) IEEE 802.11 - received signal strength */
+ COL_TX_RATE, /**< 36) IEEE 802.11 - TX rate in Mbps */
+ COL_DSCP_VALUE, /**< 37) IP DSCP Value */
+ COL_INFO, /**< 38) Description */
+ COL_COS_VALUE, /**< 39) !! DEPRECATED !! - L2 COS Value */
+ COL_RES_NET_DST, /**< 40) Resolved net dest */
+ COL_UNRES_NET_DST, /**< 41) Unresolved net dest */
+ COL_RES_NET_SRC, /**< 42) Resolved net source */
+ COL_UNRES_NET_SRC, /**< 43) Unresolved net source */
+ COL_DEF_NET_DST, /**< 44) Network layer dest address */
+ COL_DEF_NET_SRC, /**< 45) Network layer source address */
+ COL_NUMBER, /**< 46) Packet list item number */
+ COL_PACKET_LENGTH, /**< 47) Packet length in bytes */
+ COL_PROTOCOL, /**< 48) Protocol */
+ COL_REL_TIME, /**< 49) Relative time */
+ COL_REL_CONV_TIME, /**< 50) !! DEPRECATED !! - Relative time to beginning of conversation */
+ COL_DEF_SRC, /**< 51) Source address */
+ COL_DEF_SRC_PORT, /**< 52) Source port */
+ COL_RES_SRC, /**< 53) Resolved source */
+ COL_UNRES_SRC, /**< 54) Unresolved source */
+ COL_RES_SRC_PORT, /**< 55) Resolved source port */
+ COL_UNRES_SRC_PORT, /**< 56) Unresolved source port */
+ COL_TEI, /**< 57) Q.921 TEI */
+ COL_CLS_TIME, /**< 58) Command line-specified time (default relative) */
+ NUM_COL_FMTS /**< 59) Should always be last */
};
#ifdef __cplusplus
diff --git a/epan/crypt/airpdcap_int.h b/epan/crypt/airpdcap_int.h
index cc219fc3ca..b0fcfdffdc 100644
--- a/epan/crypt/airpdcap_int.h
+++ b/epan/crypt/airpdcap_int.h
@@ -78,7 +78,7 @@
*/
#define AIRPDCAP_EXTIV(KeyID) ((KeyID >> 5) & 0x1)
-#define AIRPDCAP_KEY_INDEX(KeyID) ((KeyID >> 6) & 0x3) /* Used to determine TKIP group key from unicast (group = 1, unicast = 0) */
+#define AIRPDCAP_KEY_INDEX(KeyID) ((KeyID >> 6) & 0x3) /** Used to determine TKIP group key from unicast (group = 1, unicast = 0) */
/* Macros to get various bits of an EAPOL frame */
#define AIRPDCAP_EAP_KEY_DESCR_VER(KeyInfo_1) ((UCHAR)(KeyInfo_1 & 0x3))
diff --git a/epan/crypt/crypt-md5.h b/epan/crypt/crypt-md5.h
index f10da7e707..f18ef82eaf 100644
--- a/epan/crypt/crypt-md5.h
+++ b/epan/crypt/crypt-md5.h
@@ -26,7 +26,7 @@
* @brief MD5 Functions
*/
-/**
+/* Don't define this group for Wireshark
* @defgroup PJLIB_UTIL_MD5 MD5 Functions
* @ingroup PJLIB_UTIL
* @{
@@ -64,7 +64,7 @@ void md5_finish(md5_state_t *pms, guint8 digest[16]);
void md5_hmac(const guint8* text, size_t text_len, const guint8* key, size_t key_len, guint8 digest[16]);
-/**
+/*
* @}
*/
diff --git a/epan/dfilter/syntax-tree.h b/epan/dfilter/syntax-tree.h
index 27f0aec58e..6318b02e8f 100644
--- a/epan/dfilter/syntax-tree.h
+++ b/epan/dfilter/syntax-tree.h
@@ -26,6 +26,9 @@
#include <glib.h>
#include "cppmagic.h"
+/** @file
+ */
+
typedef enum {
STTYPE_UNINITIALIZED,
STTYPE_TEST,
@@ -51,7 +54,7 @@ typedef struct {
STTypeFreeFunc func_free;
} sttype_t;
-/* Node (type instance) information */
+/** Node (type instance) information */
typedef struct {
guint32 magic;
sttype_t *type;
diff --git a/epan/emem.h b/epan/emem.h
index 48aa206b23..a2646d0c23 100644
--- a/epan/emem.h
+++ b/epan/emem.h
@@ -27,8 +27,9 @@
#define __EMEM_H__
#include "g_gnuc_malloc.h"
-
-/* Initialize all the memory allocation pools described below.
+/** @file
+ */
+/** Initialize all the memory allocation pools described below.
* This function must be called once when *shark initialize to set up the
* required structures.
*/
@@ -46,37 +47,37 @@ void emem_init(void);
* the previous packet is freed.
*/
-/* Allocate memory with a packet lifetime scope */
+/** Allocate memory with a packet lifetime scope */
void *ep_alloc(size_t size) G_GNUC_MALLOC;
#define ep_new(type) ((type*)ep_alloc(sizeof(type)))
-/* Allocate memory with a packet lifetime scope and fill it with zeros*/
+/** Allocate memory with a packet lifetime scope and fill it with zeros*/
void* ep_alloc0(size_t size) G_GNUC_MALLOC;
#define ep_new0(type) ((type*)ep_alloc0(sizeof(type)))
-/* Duplicate a string with a packet lifetime scope */
+/** Duplicate a string with a packet lifetime scope */
gchar* ep_strdup(const gchar* src) G_GNUC_MALLOC;
-/* Duplicate at most n characters of a string with a packet lifetime scope */
+/** Duplicate at most n characters of a string with a packet lifetime scope */
gchar* ep_strndup(const gchar* src, size_t len) G_GNUC_MALLOC;
-/* Duplicate a buffer with a packet lifetime scope */
+/** Duplicate a buffer with a packet lifetime scope */
void* ep_memdup(const void* src, size_t len) G_GNUC_MALLOC;
-/* Create a formatted string with a packet lifetime scope */
+/** Create a formatted string with a packet lifetime scope */
gchar* ep_strdup_vprintf(const gchar* fmt, va_list ap) G_GNUC_MALLOC;
gchar* ep_strdup_printf(const gchar* fmt, ...)
G_GNUC_MALLOC G_GNUC_PRINTF(1, 2);
-/* allocates with a packet lifetime scope an array of type made of num elements */
+/** allocates with a packet lifetime scope an array of type made of num elements */
#define ep_alloc_array(type,num) (type*)ep_alloc(sizeof(type)*(num))
-/* allocates with a packet lifetime scope an array of type made of num elements,
+/** allocates with a packet lifetime scope an array of type made of num elements,
* initialised to zero.
*/
#define ep_alloc_array0(type,num) (type*)ep_alloc0(sizeof(type)*(num))
-/*
+/**
* Splits a string into a maximum of max_tokens pieces, using the given
* delimiter. If max_tokens is reached, the remainder of string is appended
* to the last token. Consecutive delimiters are treated as a single delimiter.
@@ -85,11 +86,11 @@ gchar* ep_strdup_printf(const gchar* fmt, ...)
*/
gchar** ep_strsplit(const gchar* string, const gchar* delimiter, int max_tokens);
-/* release all memory allocated in the previous packet dissection */
+/** release all memory allocated in the previous packet dissection */
void ep_free_all(void);
-/* a stack implemented using ephemeral allocators */
+/** a stack implemented using ephemeral allocators */
typedef struct _ep_stack_frame_t** ep_stack_t;
@@ -99,22 +100,22 @@ struct _ep_stack_frame_t {
struct _ep_stack_frame_t* above;
};
-/*
+/**
* creates an empty stack with a packet lifetime scope
*/
ep_stack_t ep_stack_new(void) G_GNUC_MALLOC;
-/*
+/**
* pushes item into stack, returns item
*/
void* ep_stack_push(ep_stack_t stack, void* item);
-/*
+/**
* pops an item from the stack
*/
void* ep_stack_pop(ep_stack_t stack);
-/*
+/**
* returns the item on top of the stack without popping it
*/
#define ep_stack_peek(stack) ((*(stack))->payload)
@@ -131,19 +132,19 @@ void* ep_stack_pop(ep_stack_t stack);
* These functions are very fast and offer automatic garbage collection.
*/
-/* Allocate memory with a capture lifetime scope */
+/** Allocate memory with a capture lifetime scope */
void *se_alloc(size_t size) G_GNUC_MALLOC;
-/* Allocate memory with a capture lifetime scope and fill it with zeros*/
+/** Allocate memory with a capture lifetime scope and fill it with zeros*/
void* se_alloc0(size_t size) G_GNUC_MALLOC;
-/* Duplicate a string with a capture lifetime scope */
+/** Duplicate a string with a capture lifetime scope */
gchar* se_strdup(const gchar* src) G_GNUC_MALLOC;
-/* Duplicate at most n characters of a string with a capture lifetime scope */
+/** Duplicate at most n characters of a string with a capture lifetime scope */
gchar* se_strndup(const gchar* src, size_t len) G_GNUC_MALLOC;
-/* Duplicate a buffer with a capture lifetime scope */
+/** Duplicate a buffer with a capture lifetime scope */
void* se_memdup(const void* src, size_t len) G_GNUC_MALLOC;
/* Create a formatted string with a capture lifetime scope */
@@ -151,10 +152,10 @@ gchar* se_strdup_vprintf(const gchar* fmt, va_list ap) G_GNUC_MALLOC;
gchar* se_strdup_printf(const gchar* fmt, ...)
G_GNUC_MALLOC G_GNUC_PRINTF(1, 2);
-/* allocates with a capture lifetime scope an array of type made of num elements */
+/** allocates with a capture lifetime scope an array of type made of num elements */
#define se_alloc_array(type,num) (type*)se_alloc(sizeof(type)*(num))
-/* release all memory allocated */
+/** release all memory allocated */
void se_free_all(void);
@@ -179,7 +180,7 @@ typedef struct _emem_tree_node_t {
void *data;
} emem_tree_node_t;
-/* Right now we only do basic red/black trees but in the future we might want
+/** Right now we only do basic red/black trees but in the future we might want
* to try something different, such as a tree where each node keeps track
* of how many times it has been looked up, and letting often looked up
* nodes bubble upwards in the tree using rotate_right/left.
@@ -189,7 +190,7 @@ typedef struct _emem_tree_node_t {
typedef struct _emem_tree_t {
struct _emem_tree_t *next;
int type;
- const char *name; /* just a string to make debugging easier */
+ const char *name; /**< just a string to make debugging easier */
emem_tree_node_t *tree;
void *(*malloc)(size_t);
} emem_tree_t;
@@ -197,7 +198,7 @@ typedef struct _emem_tree_t {
/* *******************************************************************
* Tree functions for SE memory allocation scope
* ******************************************************************* */
-/* This function is used to create a se based tree with monitoring.
+/** This function is used to create a se based tree with monitoring.
* When the SE heap is released back to the system the pointer to the
* tree is automatically reset to NULL.
*
@@ -205,7 +206,7 @@ typedef struct _emem_tree_t {
*/
emem_tree_t *se_tree_create(int type, const char *name) G_GNUC_MALLOC;
-/* This function is similar to the se_tree_create() call but with the
+/** This function is similar to the se_tree_create() call but with the
* difference that when the se memory is released everything including the
* pointer to the tree itself will be released.
* This tree will not be just reset to zero, it will be completely forgotten
@@ -216,48 +217,48 @@ emem_tree_t *se_tree_create(int type, const char *name) G_GNUC_MALLOC;
*/
emem_tree_t *se_tree_create_non_persistent(int type, const char *name) G_GNUC_MALLOC;
-/* se_tree_insert32
+/** se_tree_insert32
* Insert data into the tree and key it by a 32bit integer value
*/
#define se_tree_insert32 emem_tree_insert32
-/* se_tree_lookup32
+/** se_tree_lookup32
* Retrieve the data at the search key. The search key is a 32bit integer value
*/
#define se_tree_lookup32 emem_tree_lookup32
-/* se_tree_lookup32_le
+/** se_tree_lookup32_le
* Retrieve the data for the largest key that is less than or equal
* to the search key.
*/
#define se_tree_lookup32_le emem_tree_lookup32_le
-/* se_tree_insert32_array
+/** se_tree_insert32_array
* Insert data into the tree and key it by a 32bit integer value
*/
#define se_tree_insert32_array emem_tree_insert32_array
-/* se_tree_lookup32_array
+/** se_tree_lookup32_array
* Lookup data from the tree that is index by an array
*/
#define se_tree_lookup32_array emem_tree_lookup32_array
-/* se_tree_lookup32_array_le
+/** se_tree_lookup32_array_le
* Retrieve the data for the largest key that is less than or equal
* to the search key.
*/
#define se_tree_lookup32_array_le emem_tree_lookup32_array_le
-/* Create a new string based hash table */
+/** Create a new string based hash table */
#define se_tree_create_string() se_tree_create(SE_TREE_TYPE_RED_BLACK)
-/* Insert a new value under a string key */
+/** Insert a new value under a string key */
#define se_tree_insert_string emem_tree_insert_string
-/* Lookup the value under a string key */
+/** Lookup the value under a string key */
#define se_tree_lookup_string emem_tree_lookup_string
-/* Traverse a tree */
+/** Traverse a tree */
#define se_tree_foreach emem_tree_foreach
@@ -282,19 +283,19 @@ emem_tree_t *pe_tree_create(int type, const char *name) G_GNUC_MALLOC;
* Real tree functions
* ****************************************************************** */
-/* This function is used to insert a node indexed by a guint32 key value.
+/** This function is used to insert a node indexed by a guint32 key value.
* The data pointer should be allocated by the appropriate storage scope
* so that it will be released at the same time as the tree itself is
* destroyed.
*/
void emem_tree_insert32(emem_tree_t *se_tree, guint32 key, void *data);
-/* This function will look up a node in the tree indexed by a guint32 integer
+/** This function will look up a node in the tree indexed by a guint32 integer
* value.
*/
void *emem_tree_lookup32(emem_tree_t *se_tree, guint32 key);
-/* This function will look up a node in the tree indexed by a guint32 integer
+/** This function will look up a node in the tree indexed by a guint32 integer
* value.
* The function will return the node that has the largest key that is
* equal to or smaller than the search key, or NULL if no such key was
@@ -303,11 +304,11 @@ void *emem_tree_lookup32(emem_tree_t *se_tree, guint32 key);
void *emem_tree_lookup32_le(emem_tree_t *se_tree, guint32 key);
typedef struct _emem_tree_key_t {
- guint32 length; /*length in guint32 words */
+ guint32 length; /**< length in guint32 words */
guint32 *key;
} emem_tree_key_t;
-/* This function is used to insert a node indexed by a sequence of guint32
+/** This function is used to insert a node indexed by a sequence of guint32
* key values.
* The data pointer should be allocated by SE allocators so that the
* data will be released at the same time as the tree itself is destroyed.
@@ -340,12 +341,12 @@ typedef struct _emem_tree_key_t {
*/
void emem_tree_insert32_array(emem_tree_t *se_tree, emem_tree_key_t *key, void *data);
-/* This function will look up a node in the tree indexed by a sequence of
+/** This function will look up a node in the tree indexed by a sequence of
* guint32 integer values.
*/
void *emem_tree_lookup32_array(emem_tree_t *se_tree, emem_tree_key_t *key);
-/* This function will look up a node in the tree indexed by a
+/** This function will look up a node in the tree indexed by a
* multi-part tree value.
* The function will return the node that has the largest key that is
* equal to or smaller than the search key, or NULL if no such key was
@@ -355,16 +356,16 @@ void *emem_tree_lookup32_array(emem_tree_t *se_tree, emem_tree_key_t *key);
*/
void *emem_tree_lookup32_array_le(emem_tree_t *se_tree, emem_tree_key_t *key);
-/* case insensitive strings as keys */
+/** case insensitive strings as keys */
#define EMEM_TREE_STRING_NOCASE 0x00000001
-/* Insert a new value under a string key */
+/** Insert a new value under a string key */
void emem_tree_insert_string(emem_tree_t* h, const gchar* k, void* v, guint32 flags);
-/* Lookup the value under a string key */
+/** Lookup the value under a string key */
void* emem_tree_lookup_string(emem_tree_t* h, const gchar* k, guint32 flags);
-/* traverse a tree. if the callback returns TRUE the traversal will end */
+/** traverse a tree. if the callback returns TRUE the traversal will end */
typedef gboolean (*tree_foreach_func)(void *value, void *userdata);
gboolean emem_tree_foreach(emem_tree_t* emem_tree, tree_foreach_func callback, void *user_data);
@@ -375,12 +376,12 @@ gboolean emem_tree_foreach(emem_tree_t* emem_tree, tree_foreach_func callback, v
* ****************************************************************** */
typedef struct _emem_strbuf_t {
- gchar *str; /* Points to the character data. It may move as text is */
+ gchar *str; /**< Points to the character data. It may move as text is */
/* added. The str field is null-terminated and so can */
/* be used as an ordinary C string. */
- gsize len; /* strlen: ie: length of str not including trailing '\0' */
- gsize alloc_len; /* num bytes curently allocated for str: 1 .. MAX_STRBUF_LEN */
- gsize max_alloc_len; /* max num bytes to allocate for str: 1 .. MAX_STRBUF_LEN */
+ gsize len; /**< strlen: ie: length of str not including trailing '\0' */
+ gsize alloc_len; /**< num bytes curently allocated for str: 1 .. MAX_STRBUF_LEN */
+ gsize max_alloc_len; /**< max num bytes to allocate for str: 1 .. MAX_STRBUF_LEN */
} emem_strbuf_t;
/*
@@ -481,7 +482,7 @@ void emem_print_tree(emem_tree_t* emem_tree);
/* #define DEBUG_INTENSE_CANARY_CHECKS */
-/* Helper to troubleshoot ep memory corruption.
+/** Helper to troubleshoot ep memory corruption.
* If compiled and the environment variable WIRESHARK_DEBUG_EP_INTENSE_CANARY exists
* it will check the canaries and when found corrupt stop there in the hope
* the corruptor is still there in the stack.
@@ -498,13 +499,20 @@ void ep_check_canary_integrity(const char* fmt, ...)
#endif
/**
- * Verify that the given pointer is of ephemeral/seasonal type.
+ * Verify that the given pointer is of ephemeral type.
*
* @param ptr The pointer to verify
*
- * @return TRUE if the pointer belongs to the ephemeral/seasonal pool.
+ * @return TRUE if the pointer belongs to the ephemeral pool.
*/
gboolean ep_verify_pointer(const void *ptr);
+/**
+ * Verify that the given pointer is of seasonal type.
+ *
+ * @param ptr The pointer to verify
+ *
+ * @return TRUE if the pointer belongs to the seasonal pool.
+ */
gboolean se_verify_pointer(const void *ptr);
#endif /* emem.h */
diff --git a/epan/epan.h b/epan/epan.h
index ab0c51ae7d..3beb8e9047 100644
--- a/epan/epan.h
+++ b/epan/epan.h
@@ -33,7 +33,7 @@ typedef struct _epan_dissect_t epan_dissect_t;
#include "dfilter/dfilter.h"
-/* init the whole epan module, this is used to be called only once in a program */
+/** init the whole epan module, this is used to be called only once in a program */
void epan_init(void (*register_all_protocols_func)(register_cb cb, gpointer client_data),
void (*register_all_handoffs_func)(register_cb cb, gpointer client_data),
register_cb cb,
@@ -43,10 +43,10 @@ void epan_init(void (*register_all_protocols_func)(register_cb cb, gpointer clie
void (*report_read_failure_fcn_p)(const char *, int),
void (*report_write_failure_fcn_p)(const char *, int));
-/* cleanup the whole epan module, this is used to be called only once in a program */
+/** cleanup the whole epan module, this is used to be called only once in a program */
void epan_cleanup(void);
-/*
+/**
* Initialize the table of conversations. Conversations are identified by
* their endpoints; they are used for protocols such as IP, TCP, and UDP,
* where packets contain endpoint information but don't contain a single
@@ -55,7 +55,7 @@ void epan_cleanup(void);
void epan_conversation_init(void);
void epan_conversation_cleanup(void);
-/*
+/**
* Initialize the table of circuits. Circuits are identified by a
* circuit ID; they are used for protocols where packets *do* contain
* a circuit ID value indicating to which flow the packet belongs.
@@ -68,7 +68,7 @@ void epan_conversation_cleanup(void);
void epan_circuit_init(void);
void epan_circuit_cleanup(void);
-/* A client will create one epan_t for an entire dissection session.
+/** A client will create one epan_t for an entire dissection session.
* A single epan_t will be used to analyze the entire sequence of packets,
* sequentially, in a single session. A session corresponds to a single
* packet trace file. The reaons epan_t exists is that some packets in
@@ -87,52 +87,53 @@ epan_free(epan_t*);
extern gchar*
epan_get_version(void);
-/* initialize an existing single packet dissection */
+/** initialize an existing single packet dissection */
epan_dissect_t*
epan_dissect_init(epan_dissect_t *edt, const gboolean create_proto_tree, const gboolean proto_tree_visible);
-/* get a new single packet dissection */
-/* should be freed using epan_dissect_free() after packet dissection completed */
+/** get a new single packet dissection
+ * should be freed using epan_dissect_free() after packet dissection completed
+ */
epan_dissect_t*
epan_dissect_new(const gboolean create_proto_tree, const gboolean proto_tree_visible);
-/* Indicate whether we should fake protocols or not */
+/** Indicate whether we should fake protocols or not */
void
epan_dissect_fake_protocols(epan_dissect_t *edt, const gboolean fake_protocols);
-/* run a single packet dissection */
+/** run a single packet dissection */
void
epan_dissect_run(epan_dissect_t *edt, void* pseudo_header,
const guint8* data, frame_data *fd, column_info *cinfo);
-/* Prime a proto_tree using the fields/protocols used in a dfilter. */
+/** Prime a proto_tree using the fields/protocols used in a dfilter. */
void
epan_dissect_prime_dfilter(epan_dissect_t *edt, const dfilter_t *dfcode);
-/* fill the dissect run output into the packet list columns */
+/** fill the dissect run output into the packet list columns */
void
epan_dissect_fill_in_columns(epan_dissect_t *edt, const gboolean fill_col_exprs, const gboolean fill_fd_colums);
-/* releases resources attached to the packet dissection. DOES NOT free the actual pointer */
+/** releases resources attached to the packet dissection. DOES NOT free the actual pointer */
void
epan_dissect_cleanup(epan_dissect_t* edt);
-/* free a single packet dissection */
+/** free a single packet dissection */
void
epan_dissect_free(epan_dissect_t* edt);
-/* Sets custom column */
+/** Sets custom column */
const gchar *
epan_custom_set(epan_dissect_t *edt, int id,
gchar *result, gchar *expr, const int size);
-/*
+/**
* Get compile-time information for libraries used by libwireshark.
*/
void
epan_get_compiled_version_info(GString *str);
-/*
+/**
* Get runtime information for libraries used by libwireshark.
*/
void
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;
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,
diff --git a/epan/ipv6-utils.h b/epan/ipv6-utils.h
index b1d300d9a7..741755aff1 100644
--- a/epan/ipv6-utils.h
+++ b/epan/ipv6-utils.h
@@ -29,7 +29,7 @@
#define __IPV6_UTILS_H__
struct e_in6_addr {
- guint8 bytes[16]; /** 128 bit IP6 address */
+ guint8 bytes[16]; /**< 128 bit IP6 address */
};
/**
diff --git a/epan/nstime.h b/epan/nstime.h
index f7cf0957f1..a9c11abb05 100644
--- a/epan/nstime.h
+++ b/epan/nstime.h
@@ -29,6 +29,11 @@
#include <wiretap/wtap.h>
+/** @file
+ * Definition of data structure to hold time values with nanosecond resolution
+ */
+
+/** data structure to hold time values with nanosecond resolution*/
typedef struct {
time_t secs;
int nsecs;
@@ -36,13 +41,13 @@ typedef struct {
/* functions */
-/* set the given nstime_t to zero */
+/** set the given nstime_t to zero */
extern void nstime_set_zero(nstime_t *nstime);
-/* is the given nstime_t currently zero? */
+/** is the given nstime_t currently zero? */
extern gboolean nstime_is_zero(nstime_t *nstime);
-/* set the given nstime_t to (0,maxint) to mark it as "unset"
+/** set the given nstime_t to (0,maxint) to mark it as "unset"
* That way we can find the first frame even when a timestamp
* is zero (fix for bug 1056)
*/
@@ -51,7 +56,7 @@ extern void nstime_set_unset(nstime_t *nstime);
/* is the given nstime_t currently (0,maxint)? */
extern gboolean nstime_is_unset(nstime_t *nstime);
-/* calculate the delta between two times (can be negative!)
+/** calculate the delta between two times (can be negative!)
*
* delta = b-a
*
@@ -60,7 +65,7 @@ extern gboolean nstime_is_unset(nstime_t *nstime);
*/
extern void nstime_delta(nstime_t *delta, const nstime_t *b, const nstime_t *a );
-/* calculate the sum of two times
+/** calculate the sum of two times
*
* sum = a+b
*
@@ -69,10 +74,10 @@ extern void nstime_delta(nstime_t *delta, const nstime_t *b, const nstime_t *a )
*/
extern void nstime_sum(nstime_t *sum, const nstime_t *b, const nstime_t *a );
-/* sum += a */
+/** sum += a */
#define nstime_add(sum, a) nstime_sum(sum, sum, a)
-/* compare two times are return a value similar to memcmp() or strcmp().
+/** compare two times are return a value similar to memcmp() or strcmp().
*
* a > b : > 0
* a = b : 0
@@ -80,13 +85,13 @@ extern void nstime_sum(nstime_t *sum, const nstime_t *b, const nstime_t *a );
*/
extern int nstime_cmp (const nstime_t *a, const nstime_t *b );
-/* converts nstime to double, time base is milli seconds */
+/** converts nstime to double, time base is milli seconds */
extern double nstime_to_msec(const nstime_t *nstime);
-/* converts nstime to double, time base is seconds */
+/** converts nstime to double, time base is seconds */
extern double nstime_to_sec(const nstime_t *nstime);
-/* converts wtap_nstime to double, time base is seconds */
+/** converts wtap_nstime to double, time base is seconds */
extern double wtap_nstime_to_sec(const struct wtap_nstime *nstime);
#endif /* __NSTIME_H__ */
diff --git a/epan/oids.h b/epan/oids.h
index 285a3a5537..9a07cd1d83 100644
--- a/epan/oids.h
+++ b/epan/oids.h
@@ -96,7 +96,7 @@ typedef struct _oid_info_t {
guint32 subid;
char* name;
oid_kind_t kind;
- void* children; /* an emem_tree_t* */
+ void* children; /**< an emem_tree_t* */
const oid_value_type_t* value_type;
int value_hfid;
oid_key_t* key;
diff --git a/epan/prefs-int.h b/epan/prefs-int.h
index 199c480c2e..ede8afccb7 100644
--- a/epan/prefs-int.h
+++ b/epan/prefs-int.h
@@ -33,15 +33,15 @@
*/
struct pref_module {
- const char *name; /** name of module */
- const char *title; /** title of module (displayed in preferences list) */
- const char *description; /** Description of module (displayed in preferences notebook) */
- void (*apply_cb)(void); /** routine to call when preferences applied */
- GList *prefs; /** list of its preferences */
- emem_tree_t *submodules; /** list of its submodules */
- int numprefs; /** number of non-obsolete preferences */
- gboolean prefs_changed; /** if TRUE, a preference has changed since we last checked */
- gboolean obsolete; /** if TRUE, this is a module that used to
+ const char *name; /**< name of module */
+ const char *title; /**< title of module (displayed in preferences list) */
+ const char *description; /**< Description of module (displayed in preferences notebook) */
+ void (*apply_cb)(void); /**< routine to call when preferences applied */
+ GList *prefs; /**< list of its preferences */
+ emem_tree_t *submodules; /**< list of its submodules */
+ int numprefs; /**< number of non-obsolete preferences */
+ gboolean prefs_changed; /**< if TRUE, a preference has changed since we last checked */
+ gboolean obsolete; /**< if TRUE, this is a module that used to
* exist but no longer does
*/
};
@@ -69,11 +69,11 @@ typedef enum {
/** Struct to hold preference data */
struct preference {
- const char *name; /** name of preference */
- const char *title; /** title to use in GUI */
- const char *description; /** human-readable description of preference */
- int ordinal; /** ordinal number of this preference */
- pref_type_t type; /** type of that preference */
+ const char *name; /**< name of preference */
+ const char *title; /**< title to use in GUI */
+ const char *description; /**< human-readable description of preference */
+ int ordinal; /**< ordinal number of this preference */
+ pref_type_t type; /**< type of that preference */
union {
guint *uint;
gboolean *boolp;
@@ -81,33 +81,33 @@ struct preference {
const char **string;
range_t **range;
void* uat;
- } varp; /** pointer to variable storing the value */
+ } varp; /**< pointer to variable storing the value */
union {
guint uint;
gboolean boolval;
gint enumval;
char *string;
range_t *range;
- } saved_val; /** original value, when editing from the GUI */
+ } saved_val; /**< original value, when editing from the GUI */
union {
guint uint;
gboolean boolval;
gint enumval;
char *string;
range_t *range;
- } default_val; /** the default value of the preference */
+ } default_val; /**< the default value of the preference */
union {
- guint base; /** input/output base, for PREF_UINT */
- guint32 max_value; /** maximum value of a range */
+ guint base; /**< input/output base, for PREF_UINT */
+ guint32 max_value; /**< maximum value of a range */
struct {
- const enum_val_t *enumvals; /** list of name & values */
- gboolean radio_buttons; /** TRUE if it should be shown as
+ const enum_val_t *enumvals; /**< list of name & values */
+ gboolean radio_buttons; /**< TRUE if it should be shown as
radio buttons rather than as an
option menu or combo box in
the preferences tab */
- } enum_info; /** for PREF_ENUM */
- } info; /** display/text file information */
- void *control; /** handle for GUI control for this preference */
+ } enum_info; /**< for PREF_ENUM */
+ } info; /**< display/text file information */
+ void *control; /**< handle for GUI control for this preference */
};
/* read_prefs_file: read in a generic config file and do a callback to */
diff --git a/epan/proto.h b/epan/proto.h
index 98465ba2cf..ee672a7555 100644
--- a/epan/proto.h
+++ b/epan/proto.h
@@ -370,7 +370,7 @@ typedef proto_node proto_item;
*/
/* expert severities */
-#define PI_SEVERITY_MASK 0x00F00000 /* mask usually for internal use only! */
+#define PI_SEVERITY_MASK 0x00F00000 /**< mask usually for internal use only! */
/** Usual workflow, e.g. TCP connection establishing */
#define PI_CHAT 0x00200000
/** Notable messages, e.g. an application returned an "usual" error code like HTTP 404 */
@@ -381,7 +381,7 @@ typedef proto_node proto_item;
#define PI_ERROR 0x00800000
/* expert "event groups" */
-#define PI_GROUP_MASK 0xFF000000 /* mask usually for internal use only! */
+#define PI_GROUP_MASK 0xFF000000 /**< mask usually for internal use only! */
/** The protocol field has a bad checksum, usually PI_WARN */
#define PI_CHECKSUM 0x01000000
diff --git a/epan/stats_tree_priv.h b/epan/stats_tree_priv.h
index 46ba71bbe4..ca4d1362c1 100644
--- a/epan/stats_tree_priv.h
+++ b/epan/stats_tree_priv.h
@@ -31,15 +31,15 @@
#define INDENT_MAX 32
#define NUM_BUF_SIZE 32
-/* implementations should define this to contain its own node related data
+/** implementations should define this to contain its own node related data
* as well as some operations on it */
typedef struct _st_node_pres st_node_pres;
-/* implementations should define this to contain its own dynamic tree related data
+/** implementations should define this to contain its own dynamic tree related data
* as well as some operations on it */
typedef struct _tree_pres tree_pres;
-/* implementations should define this to contain its own static tree related data
+/** implementations should define this to contain its own static tree related data
* as well as some operations on it */
typedef struct _tree_cfg_pres tree_cfg_pres;
@@ -56,29 +56,29 @@ struct _stat_node {
gchar* name;
int id;
- /* the counter it keeps */
+ /** the counter it keeps */
gint counter;
- /* children nodes by name */
+ /** children nodes by name */
GHashTable *hash;
- /* the owner of this node */
+ /** the owner of this node */
stats_tree *st;
- /* relatives */
+ /** relatives */
stat_node *parent;
stat_node *children;
stat_node *next;
- /* used to check if value is within range */
+ /** used to check if value is within range */
range_pair_t *rng;
- /* node presentation data */
+ /** node presentation data */
st_node_pres *pr;
};
struct _stats_tree {
- /* the "class" from which it's derived */
+ /** the "class" from which it's derived */
stats_tree_cfg *cfg;
char *filter;
@@ -87,22 +87,22 @@ struct _stats_tree {
double start;
double elapsed;
- /* used to lookup named parents:
+ /** used to lookup named parents:
* key: parent node name
* value: parent node
*/
GHashTable *names;
- /* used for quicker lookups of parent nodes */
+ /** used for quicker lookups of parent nodes */
GPtrArray *parents;
- /*
+ /**
* tree representation
* to be defined (if needed) by the implementations
*/
tree_pres *pr;
- /* every tree in nature has one */
+ /** every tree in nature has one */
stat_node root;
};
@@ -114,29 +114,29 @@ struct _stats_tree_cfg {
gboolean in_use;
- /* dissector defined callbacks */
+ /** dissector defined callbacks */
stat_tree_packet_cb packet;
stat_tree_init_cb init;
stat_tree_cleanup_cb cleanup;
- /* tap listener flags for the per-packet callback */
+ /** tap listener flags for the per-packet callback */
guint flags;
/*
* node presentation callbacks
*/
- /* last to be called at node creation */
+ /** last to be called at node creation */
void (*setup_node_pr)(stat_node*);
- /* last to be called at node destruction */
+ /** last to be called at node destruction */
void (*free_node_pr)(stat_node*);
- /* to be called for every node in the tree */
+ /** to be called for every node in the tree */
void (*draw_node)(stat_node*);
void (*reset_node)(stat_node*);
- /*
+ /**
* tree presentation callbacks
*/
tree_cfg_pres *pr;
@@ -162,26 +162,26 @@ extern void stats_tree_presentation(void (*registry_iterator)(gpointer,gpointer,
extern stats_tree *stats_tree_new(stats_tree_cfg *cfg, tree_pres *pr, const char *filter);
-/* callback for taps */
+/** callback for taps */
extern int stats_tree_packet(void*, packet_info*, epan_dissect_t*, const void *);
-/* callback for reset */
+/** callback for reset */
extern void stats_tree_reset(void *p_st);
-/* callback for clear */
+/** callback for clear */
extern void stats_tree_reinit(void *p_st);
/* callback for destoy */
extern void stats_tree_free(stats_tree *st);
-/* given an optarg splits the abbr part
+/** given an optarg splits the abbr part
and returns a newly allocated buffer containing it */
extern gchar *stats_tree_get_abbr(const gchar *optarg);
-/* obtains a stats tree from the registry given its abbr */
+/** obtains a stats tree from the registry given its abbr */
extern stats_tree_cfg *stats_tree_get_cfg_by_abbr(gchar *abbr);
-/* extracts node data as strings from a stat_node into
+/** extracts node data as strings from a stat_node into
the buffers given by value, rate and precent
if NULL they are ignored */
extern void stats_tree_get_strs_from_node(const stat_node *node,
@@ -189,16 +189,16 @@ extern void stats_tree_get_strs_from_node(const stat_node *node,
gchar *rate,
gchar *percent);
-/* populates the given GString with a tree representation of a branch given by node,
+/** populates the given GString with a tree representation of a branch given by node,
using indent spaces as indentation */
extern void stats_tree_branch_to_str(const stat_node *node,
GString *s,
guint indent);
-/* used to calcuate the size of the indentation and the longest string */
+/** used to calcuate the size of the indentation and the longest string */
extern guint stats_tree_branch_max_namelen(const stat_node *node, guint indent);
-/* a text representation of a node,
+/** a text representation of a node,
if buffer is NULL returns a newly allocated string */
extern gchar *stats_tree_node_to_str(const stat_node *node,
gchar *buffer, guint len);
diff --git a/epan/strutil.h b/epan/strutil.h
index 27c2361309..83c040a06e 100644
--- a/epan/strutil.h
+++ b/epan/strutil.h
@@ -64,6 +64,17 @@ int get_token_len(const guchar *linep, const guchar *lineend,
*/
gchar* format_text(const guchar *line, size_t len);
+/**
+ * Given a string, generate a string from it that shows non-printable
+ * characters as C-style escapes except a whitespace character
+ * (space, tab, carriage return, new line, vertical tab, or formfeed)
+ * which will be replaced by a space, and return a pointer to it.
+ *
+ * @param line A pointer to the input string
+ * @param len The length of the input string
+ * @return A pointer to the formatted string
+ *
+ */
gchar* format_text_wsp(const guchar *line, size_t len);
/** Turn an array of bytes into a string showing the bytes in hex.
@@ -141,7 +152,7 @@ gboolean oid_str_to_bytes(const char *oid_str, GByteArray *bytes);
* @param ba The byte array to be copied.
* @return If ba exists, a freshly allocated copy. NULL otherwise.
*
- * XXX - Should this be in strutil.c?
+ * @todo - Should this be in strutil.c?
*/
GByteArray *byte_array_dup(GByteArray *ba);
@@ -154,7 +165,7 @@ GByteArray *byte_array_dup(GByteArray *ba);
* their contents are equal, returns TRUE. Otherwise, returns
* FALSE.
*
- * XXX - Should this be in strutil.c?
+ * @todo - Should this be in strutil.c?
*/
gboolean byte_array_equal(GByteArray *ba1, GByteArray *ba2);
@@ -182,7 +193,7 @@ gchar* xml_escape(const gchar *unescaped);
const guint8 * epan_memmem(const guint8 *haystack, guint haystack_len,
const guint8 *needle, guint needle_len);
-/* Surround a string or a macro, resolved to a string, with double quotes */
+/** Surround a string or a macro, resolved to a string, with double quotes */
#define _STRINGIFY(a) # a
#define STRINGIFY(a) _STRINGIFY(a)
diff --git a/epan/tfs.h b/epan/tfs.h
index 9db9a0448c..f1e2cbabd8 100644
--- a/epan/tfs.h
+++ b/epan/tfs.h
@@ -26,10 +26,14 @@
#ifndef __TFS_H__
#define __TFS_H__
-/* Struct for boolean enumerations */
+/** @file
+ * true_false strings
+ */
+
+/** Struct for boolean enumerations */
typedef struct true_false_string {
- const char *true_string;
- const char *false_string;
+ const char *true_string; /**< The string presented when true */
+ const char *false_string; /**< The string presented when false */
} true_false_string;
/*
diff --git a/epan/tvbuff.h b/epan/tvbuff.h
index dc9da133bf..c3d059f07f 100644
--- a/epan/tvbuff.h
+++ b/epan/tvbuff.h
@@ -59,11 +59,12 @@ typedef enum {
} tvbuff_type;
typedef struct {
- /* The backing tvbuff_t */
+ /** The backing tvbuff_t */
struct tvbuff *tvb;
- /* The offset/length of 'tvb' to which I'm privy */
+ /** The offset of 'tvb' to which I'm privy */
guint offset;
+ /** The length of 'tvb' to which I'm privy */
guint length;
} tvb_backing_t;
@@ -86,21 +87,21 @@ typedef struct tvbuff {
tvbuff_type type;
gboolean initialized;
guint usage_count;
- struct tvbuff *ds_tvb; /* data source top-level tvbuff */
+ struct tvbuff *ds_tvb; /**< data source top-level tvbuff */
- /* The tvbuffs in which this tvbuff is a member
+ /** The tvbuffs in which this tvbuff is a member
* (that is, a backing tvbuff for a TVBUFF_SUBSET
* or a member for a TVB_COMPOSITE) */
GSList *used_in;
- /* TVBUFF_SUBSET and TVBUFF_COMPOSITE keep track
+ /** TVBUFF_SUBSET and TVBUFF_COMPOSITE keep track
* of the other tvbuff's they use */
union {
tvb_backing_t subset;
tvb_comp_t composite;
} tvbuffs;
- /* We're either a TVBUFF_REAL_DATA or a
+ /** We're either a TVBUFF_REAL_DATA or a
* TVBUFF_SUBSET that has a backing buffer that
* has real_data != NULL, or a TVBUFF_COMPOSITE
* which has flattened its data due to a call
@@ -108,16 +109,16 @@ typedef struct tvbuff {
*/
const guint8 *real_data;
- /* Length of virtual buffer (and/or real_data). */
+ /** Length of virtual buffer (and/or real_data). */
guint length;
- /* Reported length. */
+ /** Reported length. */
guint reported_length;
/* Offset from beginning of first TVBUFF_REAL. */
gint raw_offset;
- /* Func to call when actually freed */
+ /** Func to call when actually freed */
tvbuff_free_cb_t free_cb;
} tvbuff_t;
diff --git a/epan/wslua/init_wslua.h b/epan/wslua/init_wslua.h
index 060a26f0d8..8e912e60fb 100644
--- a/epan/wslua/init_wslua.h
+++ b/epan/wslua/init_wslua.h
@@ -33,8 +33,8 @@
* @ingroup wslua_group
*/
typedef struct _wslua_plugin {
- gchar *name; /* plugin name */
- gchar *version; /* plugin version */
+ gchar *name; /**< plugin name */
+ gchar *version; /**< plugin version */
struct _wslua_plugin *next;
} wslua_plugin;
diff --git a/epan/xdlc.h b/epan/xdlc.h
index d081537b1e..a45797f4fc 100644
--- a/epan/xdlc.h
+++ b/epan/xdlc.h
@@ -26,69 +26,73 @@
#ifndef __XDLC_H__
#define __XDLC_H__
+/** @file
+ * Define *DLC frame types, and routine to dissect the control field of
+ * a *DLC frame.
+ */
/*
* Low-order bits of first (extended) or only (basic) octet of control
* field, specifying the frame type.
*/
-#define XDLC_I_MASK 0x01 /* Mask to test for I or not I */
-#define XDLC_I 0x00 /* Information frames */
-#define XDLC_S_U_MASK 0x03 /* Mask to test for S or U */
-#define XDLC_S 0x01 /* Supervisory frames */
-#define XDLC_U 0x03 /* Unnumbered frames */
+#define XDLC_I_MASK 0x01 /**< Mask to test for I or not I */
+#define XDLC_I 0x00 /**< Information frames */
+#define XDLC_S_U_MASK 0x03 /**< Mask to test for S or U */
+#define XDLC_S 0x01 /**< Supervisory frames */
+#define XDLC_U 0x03 /**< Unnumbered frames */
/*
* N(S) and N(R) fields, in basic and extended operation.
*/
-#define XDLC_N_R_MASK 0xE0 /* basic */
+#define XDLC_N_R_MASK 0xE0 /*< basic */
#define XDLC_N_R_SHIFT 5
-#define XDLC_N_R_EXT_MASK 0xFE00 /* extended */
+#define XDLC_N_R_EXT_MASK 0xFE00 /*< extended */
#define XDLC_N_R_EXT_SHIFT 9
-#define XDLC_N_S_MASK 0x0E /* basic */
+#define XDLC_N_S_MASK 0x0E /*< basic */
#define XDLC_N_S_SHIFT 1
-#define XDLC_N_S_EXT_MASK 0x00FE /* extended */
+#define XDLC_N_S_EXT_MASK 0x00FE /*< extended */
#define XDLC_N_S_EXT_SHIFT 1
/*
* Poll/Final bit, in basic and extended operation.
*/
-#define XDLC_P_F 0x10 /* basic */
-#define XDLC_P_F_EXT 0x0100 /* extended */
+#define XDLC_P_F 0x10 /*< basic */
+#define XDLC_P_F_EXT 0x0100 /*< extended */
/*
* S-format frame types.
*/
#define XDLC_S_FTYPE_MASK 0x0C
-#define XDLC_RR 0x00 /* Receiver ready */
-#define XDLC_RNR 0x04 /* Receiver not ready */
-#define XDLC_REJ 0x08 /* Reject */
-#define XDLC_SREJ 0x0C /* Selective reject */
+#define XDLC_RR 0x00 /**< Receiver ready */
+#define XDLC_RNR 0x04 /**< Receiver not ready */
+#define XDLC_REJ 0x08 /**< Reject */
+#define XDLC_SREJ 0x0C /**< Selective reject */
/*
* U-format modifiers.
*/
#define XDLC_U_MODIFIER_MASK 0xEC
-#define XDLC_UI 0x00 /* Unnumbered Information */
-#define XDLC_UP 0x20 /* Unnumbered Poll */
-#define XDLC_DISC 0x40 /* Disconnect (command) */
-#define XDLC_RD 0x40 /* Request Disconnect (response) */
-#define XDLC_UA 0x60 /* Unnumbered Acknowledge */
-#define XDLC_SNRM 0x80 /* Set Normal Response Mode */
-#define XDLC_TEST 0xE0 /* Test */
-#define XDLC_SIM 0x04 /* Set Initialization Mode (command) */
-#define XDLC_RIM 0x04 /* Request Initialization Mode (response) */
-#define XDLC_FRMR 0x84 /* Frame reject */
-#define XDLC_CFGR 0xC4 /* Configure */
-#define XDLC_SARM 0x0C /* Set Asynchronous Response Mode (command) */
-#define XDLC_DM 0x0C /* Disconnected mode (response) */
-#define XDLC_SABM 0x2C /* Set Asynchronous Balanced Mode */
-#define XDLC_SARME 0x4C /* Set Asynchronous Response Mode Extended */
-#define XDLC_SABME 0x6C /* Set Asynchronous Balanced Mode Extended */
-#define XDLC_RESET 0x8C /* Reset */
-#define XDLC_XID 0xAC /* Exchange identification */
-#define XDLC_SNRME 0xCC /* Set Normal Response Mode Extended */
-#define XDLC_BCN 0xEC /* Beacon */
+#define XDLC_UI 0x00 /**< Unnumbered Information */
+#define XDLC_UP 0x20 /**< Unnumbered Poll */
+#define XDLC_DISC 0x40 /**< Disconnect (command) */
+#define XDLC_RD 0x40 /**< Request Disconnect (response) */
+#define XDLC_UA 0x60 /**< Unnumbered Acknowledge */
+#define XDLC_SNRM 0x80 /**< Set Normal Response Mode */
+#define XDLC_TEST 0xE0 /**< Test */
+#define XDLC_SIM 0x04 /**< Set Initialization Mode (command) */
+#define XDLC_RIM 0x04 /**< Request Initialization Mode (response) */
+#define XDLC_FRMR 0x84 /**< Frame reject */
+#define XDLC_CFGR 0xC4 /**< Configure */
+#define XDLC_SARM 0x0C /**< Set Asynchronous Response Mode (command) */
+#define XDLC_DM 0x0C /**< Disconnected mode (response) */
+#define XDLC_SABM 0x2C /**< Set Asynchronous Balanced Mode */
+#define XDLC_SARME 0x4C /**< Set Asynchronous Response Mode Extended */
+#define XDLC_SABME 0x6C /**< Set Asynchronous Balanced Mode Extended */
+#define XDLC_RESET 0x8C /**< Reset */
+#define XDLC_XID 0xAC /**< Exchange identification */
+#define XDLC_SNRME 0xCC /**< Set Normal Response Mode Extended */
+#define XDLC_BCN 0xEC /**< Beacon */
-/*
+/**
* This macro takes the control field of an xDLC frame, as returned by
* "get_xdlc_control()" or "dissect_xdlc_control()", and evaluates to
* TRUE if the frame is an "information" frame and FALSE if it isn't.
@@ -98,7 +102,7 @@
#define XDLC_IS_INFORMATION(control) \
(((control) & XDLC_I_MASK) == XDLC_I || (control) == (XDLC_UI|XDLC_U))
-/*
+/**
* This macro takes the control field of an xDLC frame, and a flag saying
* whether we're doing basic or extended operation, and evaluates to
* the length of that field (if it's an Unnumbered frame, or we're not
@@ -107,7 +111,7 @@
#define XDLC_CONTROL_LEN(control, is_extended) \
((((control) & XDLC_S_U_MASK) == XDLC_U || !(is_extended)) ? 1 : 2)
-/*
+/**
* Structure containing pointers to hf_ values for various subfields of
* the control field.
*/
@@ -130,7 +134,7 @@ extern const value_string modifier_vals_resp[];
extern int get_xdlc_control(const guchar *pd, int offset, gboolean is_extended);
-/*
+/**
* Check whether the control field of the packet looks valid.
*/
extern gboolean check_xdlc_control(tvbuff_t *tvb, int offset,