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

Signed-off-by: Michael Niedermayer <michael@niedermayer.cc>

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