summaryrefslogtreecommitdiff
path: root/libavutil/tree.h
diff options
context:
space:
mode:
authorLuca Barbato <lu_zero@gentoo.org>2011-11-20 20:38:24 +0100
committerLuca Barbato <lu_zero@gentoo.org>2011-11-22 17:16:02 +0100
commit757cd8d876b18c07e00b53fd4e5c01bedc106d2e (patch)
treeeab216085c5b151ac19d37f0f57df76f9d60031d /libavutil/tree.h
parent384bdaceeb9c82d5b64a6f73e5273298b38028e9 (diff)
doxy: provide a start page and document libavutil
Introduce a basic layout, the subpages are currently left empty. Split libavutil in multiple groups as example of the structure
Diffstat (limited to 'libavutil/tree.h')
-rw-r--r--libavutil/tree.h17
1 files changed, 15 insertions, 2 deletions
diff --git a/libavutil/tree.h b/libavutil/tree.h
index 9115e2fec1..59ea01dbdb 100644
--- a/libavutil/tree.h
+++ b/libavutil/tree.h
@@ -21,14 +21,24 @@
/**
* @file
* A tree container.
- * Insertion, removal, finding equal, largest which is smaller than and
- * smallest which is larger than, all have O(log n) worst case complexity.
* @author Michael Niedermayer <michaelni@gmx.at>
*/
#ifndef AVUTIL_TREE_H
#define AVUTIL_TREE_H
+/**
+ * @addtogroup lavu_tree AVTree
+ * @ingroup lavu_data
+ *
+ * Low complexity tree container
+ *
+ * Insertion, removal, finding equal, largest which is smaller than and
+ * smallest which is larger than, all have O(log n) worst case complexity.
+ * @{
+ */
+
+
struct AVTreeNode;
extern const int av_tree_node_size;
@@ -91,5 +101,8 @@ void av_tree_destroy(struct AVTreeNode *t);
*/
void av_tree_enumerate(struct AVTreeNode *t, void *opaque, int (*cmp)(void *opaque, void *elem), int (*enu)(void *opaque, void *elem));
+/**
+ * @}
+ */
#endif /* AVUTIL_TREE_H */