[FFmpeg-devel] [PATCH 2/3] avutil/tree: improve documentation for av_tree_find, av_tree_insert
gajjanagadde at gmail.com
Sun Oct 25 15:27:26 CET 2015
On Sat, Oct 24, 2015 at 6:02 PM, Ganesh Ajjanagadde
<gajjanagadde at gmail.com> wrote:
> This documents the additional constness, and provides a useful libc
> reference for the API specification of the comparator.
> Signed-off-by: Ganesh Ajjanagadde <gajjanagadde at gmail.com>
> libavutil/tree.h | 5 ++++-
> 1 file changed, 4 insertions(+), 1 deletion(-)
> diff --git a/libavutil/tree.h b/libavutil/tree.h
> index a14fa91..16dd8de 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 will contain the previous
> * element and next 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 libc'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 libc'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
pushed as part of the set.
More information about the ffmpeg-devel