summaryrefslogtreecommitdiff
path: root/libavutil/tree.h
diff options
context:
space:
mode:
authorDiego Biurrun <diego@biurrun.de>2007-02-27 14:41:03 +0000
committerDiego Biurrun <diego@biurrun.de>2007-02-27 14:41:03 +0000
commite4a4c870cb432b7de64796448655b416bfd8add0 (patch)
tree4b34a545df2e4b383cff2ff2b5da2dd3bbd894a9 /libavutil/tree.h
parent3fdb6af943dde215e761f37b3135801ad4399be9 (diff)
Add Doxygen author and file description, rephrase a Doxygen comment.
Originally committed as revision 8147 to svn://svn.ffmpeg.org/ffmpeg/trunk
Diffstat (limited to 'libavutil/tree.h')
-rw-r--r--libavutil/tree.h12
1 files changed, 9 insertions, 3 deletions
diff --git a/libavutil/tree.h b/libavutil/tree.h
index 0f982417a0..be17358580 100644
--- a/libavutil/tree.h
+++ b/libavutil/tree.h
@@ -18,6 +18,12 @@
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/
+/**
+ * @file tree.h
+ * A tree container.
+ * @author Michael Niedermayer <michaelni@gmx.at>
+ */
+
#ifndef TREE_H
#define TREE_H
@@ -42,9 +48,9 @@ void *av_tree_find(const struct AVTreeNode *root, void *key, int (*cmp)(void *ke
* to keep the tree balanced.
*
* @return If no insertion happened, the found element.
- * If an insertion happened, then either key or NULL is returned (which
- * one it is depends on the tree state and the implementation, you
- * should make no assumptions that it's one or the other in the code).
+ * If an insertion happened, then either key or NULL will be returned.
+ * Which one it is depends on the tree state and the implementation. You
+ * should make no assumptions that it's one or the other in the code.
*/
void *av_tree_insert(struct AVTreeNode **rootp, void *key, int (*cmp)(void *key, const void *b));
void av_tree_destroy(struct AVTreeNode *t);