diff options
author | Michael Niedermayer <michael@niedermayer.cc> | 2015-10-25 19:13:42 +0300 |
---|---|---|
committer | Michael Niedermayer <michael@niedermayer.cc> | 2015-10-25 19:28:47 +0300 |
commit | 65ffca9f803a65057ac6391459b70aa0fa066d80 (patch) | |
tree | c4694811e0c922411108543aad64197d091a9c74 | |
parent | 9bc3d3355f662d29e07acba94e90400a55564a38 (diff) |
avutil/tree: Document the guaranteed ordering of compare arguments for av_tree_find()
Signed-off-by: Michael Niedermayer <michael@niedermayer.cc>
-rw-r--r-- | libavutil/tree.h | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/libavutil/tree.h b/libavutil/tree.h index 337a44c2d3..e1aefaa9f6 100644 --- a/libavutil/tree.h +++ b/libavutil/tree.h @@ -58,6 +58,9 @@ struct AVTreeNode *av_tree_node_alloc(void); * 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 + * It is guranteed that the first and only the first argument to cmp() + * will be the key parameter to av_tree_find(), thus it could if the + * user wants, be a different type (like an opaque context). * @return An element with cmp(key, elem) == 0 or NULL if no such element * exists in the tree. */ |