summaryrefslogtreecommitdiff
path: root/epan/epan.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/epan.h
parent2f6dd574b7cb422e3862197416b80b3dbed0d06c (diff)
downloadwireshark-a009cc060501c8ce8ad679d58dfe32723f897154.tar.gz
Doxygen changes.
svn path=/trunk/; revision=33990
Diffstat (limited to 'epan/epan.h')
-rw-r--r--epan/epan.h35
1 files changed, 18 insertions, 17 deletions
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