From 65ffca9f803a65057ac6391459b70aa0fa066d80 Mon Sep 17 00:00:00 2001 From: Michael Niedermayer Date: Sun, 25 Oct 2015 17:13:42 +0100 Subject: avutil/tree: Document the guaranteed ordering of compare arguments for av_tree_find() Signed-off-by: Michael Niedermayer --- libavutil/tree.h | 3 +++ 1 file changed, 3 insertions(+) (limited to 'libavutil/tree.h') 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. */ -- cgit v1.2.3