Commit 94f333f9 authored by Ganesh Ajjanagadde's avatar Ganesh Ajjanagadde

avutil/tree: improve documentation for av_tree_find, av_tree_insert

This documents the additional constness, and provides a useful libc
reference for the API specification of the comparator.
Reviewed-by: 's avatarHenrik Gramner <henrik@gramner.com>
Reviewed-by: 's avatarwm4 <nfxjfg@googlemail.com>
Signed-off-by: 's avatarGanesh Ajjanagadde <gajjanagadde@gmail.com>
parent 2ee51ef2
......@@ -56,6 +56,8 @@ struct AVTreeNode *av_tree_node_alloc(void);
* @param next If next is not NULL, then next[0] will contain the previous
* element and next[1] the next element. If either does not exist,
* then the corresponding entry in next is unchanged.
* @param cmp compare function used to compare elements in the tree,
* API identical to that of Standard C's qsort
* @return An element with cmp(key, elem) == 0 or NULL if no such element
* exists in the tree.
*/
......@@ -99,7 +101,8 @@ void *av_tree_find(const struct AVTreeNode *root, void *key,
* return av_tree_insert(rootp, key, cmp, next);
* }
* @endcode
* @param cmp compare function used to compare elements in the tree
* @param cmp compare function used to compare elements in the tree, API identical
* to that of Standard C's qsort
* @return If no insertion happened, the found element; if an insertion or
* removal happened, then either key or NULL will be returned.
* Which one it is depends on the tree state and the implementation. You
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment