Mercurial > libavutil.hg
comparison tree.h @ 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 | 2498a8c0c832 |
children | d0f3bb6e367e |
comparison
equal
deleted
inserted
replaced
260:77a453e1b849 | 261:2ed59b450840 |
---|---|
14 * Lesser General Public License for more details. | 14 * Lesser General Public License for more details. |
15 * | 15 * |
16 * You should have received a copy of the GNU Lesser General Public | 16 * You should have received a copy of the GNU Lesser General Public |
17 * License along with FFmpeg; if not, write to the Free Software | 17 * License along with FFmpeg; if not, write to the Free Software |
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA | 18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA |
19 */ | |
20 | |
21 /** | |
22 * @file tree.h | |
23 * A tree container. | |
24 * @author Michael Niedermayer <michaelni@gmx.at> | |
19 */ | 25 */ |
20 | 26 |
21 #ifndef TREE_H | 27 #ifndef TREE_H |
22 #define TREE_H | 28 #define TREE_H |
23 | 29 |
40 * @param rootp A pointer to a pointer to the root node of the tree. Note that | 46 * @param rootp A pointer to a pointer to the root node of the tree. Note that |
41 * the root node can change during insertions, this is required | 47 * the root node can change during insertions, this is required |
42 * to keep the tree balanced. | 48 * to keep the tree balanced. |
43 * | 49 * |
44 * @return If no insertion happened, the found element. | 50 * @return If no insertion happened, the found element. |
45 * If an insertion happened, then either key or NULL is returned (which | 51 * If an insertion happened, then either key or NULL will be returned. |
46 * one it is depends on the tree state and the implementation, you | 52 * Which one it is depends on the tree state and the implementation. You |
47 * should make no assumptions that it's one or the other in the code). | 53 * should make no assumptions that it's one or the other in the code. |
48 */ | 54 */ |
49 void *av_tree_insert(struct AVTreeNode **rootp, void *key, int (*cmp)(void *key, const void *b)); | 55 void *av_tree_insert(struct AVTreeNode **rootp, void *key, int (*cmp)(void *key, const void *b)); |
50 void av_tree_destroy(struct AVTreeNode *t); | 56 void av_tree_destroy(struct AVTreeNode *t); |
51 | 57 |
52 #endif /* TREE_H */ | 58 #endif /* TREE_H */ |