diff options
| author | Ganesh Ajjanagadde <gajjanagadde@gmail.com> | 2015-10-25 00:47:21 +0300 |
|---|---|---|
| committer | Ganesh Ajjanagadde <gajjanagadde@gmail.com> | 2015-10-25 03:38:06 +0300 |
| commit | 94f333f9dcfb4ed13d08e17949f7a929a1ece4b1 (patch) | |
| tree | 2e91d14cb16fc5bc0846ebac91f7fdf421190b68 | |
| parent | 2ee51ef259e65e881b36aba7e6f9402b525a5ce0 (diff) | |
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: Henrik Gramner <henrik@gramner.com>
Reviewed-by: wm4 <nfxjfg@googlemail.com>
Signed-off-by: Ganesh Ajjanagadde <gajjanagadde@gmail.com>
| -rw-r--r-- | libavutil/tree.h | 5 |
1 files changed, 4 insertions, 1 deletions
diff --git a/libavutil/tree.h b/libavutil/tree.h index a14fa9156a..f04f02d8ed 100644 --- a/libavutil/tree.h +++ b/libavutil/tree.h @@ -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 |