[Ffmpeg-cvslog] r8147 - trunk/libavutil/tree.h

[diego]

Author: diego
Date: Tue Feb 27 15:41:03 2007
New Revision: 8147

Modified:
   trunk/libavutil/tree.h

Log:
Add Doxygen author and file description, rephrase a Doxygen comment.


Modified: trunk/libavutil/tree.h
==============================================================================
--- trunk/libavutil/tree.h	(original)
+++ trunk/libavutil/tree.h	Tue Feb 27 15:41:03 2007
@@ -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 at gmx.at>
+ */
+
 #ifndef TREE_H
 #define TREE_H
 
@@ -42,9 +48,9 @@ void *av_tree_find(const struct AVTreeNo
  *              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);