diff options
author | Gerald Combs <gerald@wireshark.org> | 2013-05-30 22:20:21 +0000 |
---|---|---|
committer | Gerald Combs <gerald@wireshark.org> | 2013-05-30 22:20:21 +0000 |
commit | d14fa4914d51bc18dcfd11db2bfa53273d9c3474 (patch) | |
tree | 9adf70c1e415f3e2b8ac90e01824f45a1d990d33 /epan/proto.h | |
parent | b047518b1835b516f4ac79953fc7b45e0059e14a (diff) |
Add Doxygen boilerplate for some of our core modules and data structures.
svn path=/trunk/; revision=49640
Diffstat (limited to 'epan/proto.h')
-rw-r--r-- | epan/proto.h | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/epan/proto.h b/epan/proto.h index 4478b6dbfa..a05d43fe9d 100644 --- a/epan/proto.h +++ b/epan/proto.h @@ -57,6 +57,16 @@ extern "C" { #endif /* __cplusplus */ +/** @defgroup prototree The Protocol Tree + * + * Dissectors use proto_tree_add_* to add items to the protocol tree. In + * most cases you'll want to use proto_tree_add_item(). In general + * proto_tree_add_text() should be avoided unless you explicitly don't + * want to allow filtering. + * + * @{ + */ + /** The header-field index for the special text pseudo-field. Exported by libwireshark.dll */ WS_DLL_PUBLIC int hf_text_only; @@ -2104,6 +2114,8 @@ proto_custom_set(proto_tree* tree, const int field_id, gchar *result, gchar *expr, const int size ); +/** @} */ + #ifdef __cplusplus } #endif /* __cplusplus */ |