aboutsummaryrefslogtreecommitdiffstats
path: root/epan/tvbuff.h
diff options
context:
space:
mode:
authorGerald Combs <gerald@wireshark.org>2013-05-30 22:20:21 +0000
committerGerald Combs <gerald@wireshark.org>2013-05-30 22:20:21 +0000
commitd14fa4914d51bc18dcfd11db2bfa53273d9c3474 (patch)
tree9adf70c1e415f3e2b8ac90e01824f45a1d990d33 /epan/tvbuff.h
parentb047518b1835b516f4ac79953fc7b45e0059e14a (diff)
Add Doxygen boilerplate for some of our core modules and data structures.
svn path=/trunk/; revision=49640
Diffstat (limited to 'epan/tvbuff.h')
-rw-r--r--epan/tvbuff.h12
1 files changed, 9 insertions, 3 deletions
diff --git a/epan/tvbuff.h b/epan/tvbuff.h
index 8950feb68b..6c0b66ad40 100644
--- a/epan/tvbuff.h
+++ b/epan/tvbuff.h
@@ -64,8 +64,9 @@ typedef enum {
struct tvbuff;
typedef struct tvbuff tvbuff_t;
-/**
- * tvbuffs: dissector use and management
+/** @defgroup tvbuff Testy, Virtual(-izable) Buffers
+ *
+ * Dissector use and management
*
* Consider a collection of tvbs as being a chain or stack of tvbs.
*
@@ -91,7 +92,10 @@ typedef struct tvbuff tvbuff_t;
* This (obviously) also applies to any tvbs chained to the tvb handed
* to the dissector.
* - Can create its own tvb chain (using tvb_new_real_data() which the
- * dissector is free to manage as desired. */
+ *
+ * dissector is free to manage as desired.
+ * @{
+ */
/** TVBUFF_REAL_DATA contains a guint8* that points to real data.
* The data is allocated and contiguous.
@@ -698,6 +702,8 @@ extern tvbuff_t* tvb_child_uncompress(tvbuff_t *parent, tvbuff_t *tvb, const int
/************** END OF ACCESSORS ****************/
+/** @} */
+
#ifdef __cplusplus
}
#endif /* __cplusplus */