mirror of
https://git.videolan.org/git/ffmpeg.git
synced 2024-08-20 16:25:04 +02:00
lavu/tree: perform minor fixes to av_tree_insert() documentation
This commit is contained in:
parent
6adefeef45
commit
cd945d2112
@ -55,18 +55,21 @@ void *av_tree_find(const struct AVTreeNode *root, void *key, int (*cmp)(void *ke
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Insert or remove an element.
|
* Insert or remove an element.
|
||||||
|
*
|
||||||
* If *next is NULL, then the supplied element will be removed if it exists.
|
* If *next is NULL, then the supplied element will be removed if it exists.
|
||||||
* If *next is not NULL, then the supplied element will be inserted, unless
|
* If *next is non-NULL, then the supplied element will be inserted, unless
|
||||||
* it already exists in the tree.
|
* it already exists in the tree.
|
||||||
|
*
|
||||||
* @param rootp A pointer to a pointer to the root node of the tree; note that
|
* @param rootp A pointer to a pointer to the root node of the tree; note that
|
||||||
* the root node can change during insertions, this is required
|
* the root node can change during insertions, this is required
|
||||||
* to keep the tree balanced.
|
* to keep the tree balanced.
|
||||||
|
* @param key pointer to the element key to insert in the tree
|
||||||
* @param next Used to allocate and free AVTreeNodes. For insertion the user
|
* @param next Used to allocate and free AVTreeNodes. For insertion the user
|
||||||
* must set it to an allocated and zeroed object of at least
|
* must set it to an allocated and zeroed object of at least
|
||||||
* av_tree_node_size bytes size. av_tree_insert() will set it to
|
* av_tree_node_size bytes size. av_tree_insert() will set it to
|
||||||
* NULL if it has been consumed.
|
* NULL if it has been consumed.
|
||||||
* For deleting elements *next is set to NULL by the user and
|
* For deleting elements *next is set to NULL by the user and
|
||||||
* av_tree_node_size() will set it to the AVTreeNode which was
|
* av_tree_insert() will set it to the AVTreeNode which was
|
||||||
* used for the removed element.
|
* used for the removed element.
|
||||||
* This allows the use of flat arrays, which have
|
* This allows the use of flat arrays, which have
|
||||||
* lower overhead compared to many malloced elements.
|
* lower overhead compared to many malloced elements.
|
||||||
@ -81,6 +84,7 @@ void *av_tree_find(const struct AVTreeNode *root, void *key, int (*cmp)(void *ke
|
|||||||
* return av_tree_insert(rootp, key, cmp, next);
|
* return av_tree_insert(rootp, key, cmp, next);
|
||||||
* }
|
* }
|
||||||
* @endcode
|
* @endcode
|
||||||
|
* @param cmp compare function used to compare elements in the tree
|
||||||
* @return If no insertion happened, the found element; if an insertion or
|
* @return If no insertion happened, the found element; if an insertion or
|
||||||
* removal happened, then either key or NULL will be returned.
|
* removal happened, then either key or NULL will be returned.
|
||||||
* Which one it is depends on the tree state and the implementation. You
|
* Which one it is depends on the tree state and the implementation. You
|
||||||
|
Loading…
Reference in New Issue
Block a user