1
0
mirror of https://github.com/FFmpeg/FFmpeg.git synced 2024-12-23 12:43:46 +02:00

avutil/tree: Document the guaranteed ordering of compare arguments for av_tree_find()

Signed-off-by: Michael Niedermayer <michael@niedermayer.cc>
This commit is contained in:
Michael Niedermayer 2015-10-25 17:13:42 +01:00
parent 9bc3d3355f
commit 65ffca9f80

View File

@ -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.
*/