Mercurial > libavutil.hg
changeset 261:2ed59b450840 libavutil
Add Doxygen author and file description, rephrase a Doxygen comment.
| author | diego |
|---|---|
| date | Tue, 27 Feb 2007 14:41:03 +0000 |
| parents | 77a453e1b849 |
| children | dc2d5139af95 |
| files | tree.h |
| diffstat | 1 files changed, 9 insertions(+), 3 deletions(-) [+] |
line wrap: on
line diff
--- a/tree.h Tue Feb 27 00:18:38 2007 +0000 +++ b/tree.h Tue Feb 27 14:41:03 2007 +0000 @@ -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 @@ * 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);