mirror of
https://github.com/xenia-project/FFmpeg.git
synced 2024-11-24 03:59:43 +00:00
spelling/grammar fixes for the Doxygen comments
Originally committed as revision 8138 to svn://svn.ffmpeg.org/ffmpeg/trunk
This commit is contained in:
parent
7122f7c771
commit
876e4194c2
@ -26,25 +26,25 @@ struct AVTreeNode;
|
|||||||
/**
|
/**
|
||||||
* Finds an element.
|
* Finds an element.
|
||||||
* @param root a pointer to the root node of the tree
|
* @param root a pointer to the root node of the tree
|
||||||
* @param next if next is not NULL then next[0] will contain the previous element and
|
* @param next If next is not NULL then next[0] will contain the previous
|
||||||
* next[1] the next element if either doesnt exist then the corresponding
|
* element and next[1] the next element if either does not exist
|
||||||
* entry in next is unchanged
|
* then the corresponding entry in next is unchanged.
|
||||||
* @return an element with cmp(key, elem)==0 or NULL if no such element exists in
|
* @return An element with cmp(key, elem)==0 or NULL if no such element exists in
|
||||||
* the tree
|
* the tree.
|
||||||
*/
|
*/
|
||||||
void *av_tree_find(const struct AVTreeNode *root, void *key, int (*cmp)(void *key, const void *b), void *next[2]);
|
void *av_tree_find(const struct AVTreeNode *root, void *key, int (*cmp)(void *key, const void *b), void *next[2]);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Finds a element for which cmp(key, elem)==0, if no such element is found key
|
* Finds a element for which cmp(key, elem)==0, if no such element is found key
|
||||||
* is inserted into the tree.
|
* is inserted into the tree.
|
||||||
* @param rootp a pointer to a pointer to the root node of the tree note the
|
* @param rootp A pointer to a pointer to the root node of the tree. Note that
|
||||||
* root node can change during insertions, this is required to
|
* the root node can change during insertions, this is required
|
||||||
* keep the tree balanced
|
* to keep the tree balanced.
|
||||||
*
|
*
|
||||||
* @return if no insertion happened, the found element
|
* @return If no insertion happened, the found element.
|
||||||
* if a insertion happened, then either key or NULL is returned (which it is
|
* If an insertion happened, then either key or NULL is returned (which
|
||||||
* depends on the tree state and the implemenattion, you should make no
|
* one it is depends on the tree state and the implementation, you
|
||||||
* asumtations that its one or the other in code)
|
* should make no assumptions that it's one or the other in the code).
|
||||||
*/
|
*/
|
||||||
void *av_tree_insert(struct AVTreeNode **rootp, void *key, int (*cmp)(void *key, const void *b));
|
void *av_tree_insert(struct AVTreeNode **rootp, void *key, int (*cmp)(void *key, const void *b));
|
||||||
void av_tree_destroy(struct AVTreeNode *t);
|
void av_tree_destroy(struct AVTreeNode *t);
|
||||||
|
Loading…
Reference in New Issue
Block a user