ffmpeg | branch: master | Ganesh Ajjanagadde <[email protected]> | Sat Oct 24 17:47:21 2015 -0400| [94f333f9dcfb4ed13d08e17949f7a929a1ece4b1] | committer: Ganesh Ajjanagadde
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 <[email protected]> Reviewed-by: wm4 <[email protected]> Signed-off-by: Ganesh Ajjanagadde <[email protected]> > http://git.videolan.org/gitweb.cgi/ffmpeg.git/?a=commit;h=94f333f9dcfb4ed13d08e17949f7a929a1ece4b1 --- libavutil/tree.h | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/libavutil/tree.h b/libavutil/tree.h index a14fa91..f04f02d 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 _______________________________________________ ffmpeg-cvslog mailing list [email protected] http://ffmpeg.org/mailman/listinfo/ffmpeg-cvslog
