summaryrefslogtreecommitdiff
path: root/src/lib/eina
diff options
context:
space:
mode:
authorBryce Harrington <bryce@osg.samsung.com>2018-07-31 15:27:08 -0400
committerChris Michael <cp.michael@samsung.com>2018-07-31 15:27:09 -0400
commit14aeb244837ca8b2898ecff717e2a60bb7a1dd09 (patch)
tree1df551fe692c62b88086e91c8ea7580d88eceae9 /src/lib/eina
parent28d359b00c130038966afa1f6f1c5b45f2ff871f (diff)
eina: Add doxygen in/out tags for rbtree
Reviewers: devilhorns Reviewed By: devilhorns Subscribers: cedric, #committers, zmike Tags: #efl Differential Revision: https://phab.enlightenment.org/D6709
Diffstat (limited to 'src/lib/eina')
-rw-r--r--src/lib/eina/eina_rbtree.h38
1 files changed, 19 insertions, 19 deletions
diff --git a/src/lib/eina/eina_rbtree.h b/src/lib/eina/eina_rbtree.h
index ae0f82d2af..00e3eb6149 100644
--- a/src/lib/eina/eina_rbtree.h
+++ b/src/lib/eina/eina_rbtree.h
@@ -152,10 +152,10 @@ typedef void (*Eina_Rbtree_Free_Cb)(Eina_Rbtree *node, void *data);
152/** 152/**
153 * @brief Inserts a new node inside an existing red black tree. 153 * @brief Inserts a new node inside an existing red black tree.
154 * 154 *
155 * @param root The root of an existing valid red black tree. 155 * @param[in,out] root The root of an existing valid red black tree.
156 * @param node The new node to insert. 156 * @param[in] node The new node to insert.
157 * @param cmp The callback that is able to compare two nodes. 157 * @param[in] cmp The callback that is able to compare two nodes.
158 * @param data Private data to help the compare function. 158 * @param[in] data Private data to help the compare function.
159 * @return The new root of the red black tree. 159 * @return The new root of the red black tree.
160 * 160 *
161 * This function inserts a new node in a valid red black tree. @c NULL is 161 * This function inserts a new node in a valid red black tree. @c NULL is
@@ -167,10 +167,10 @@ EAPI Eina_Rbtree *eina_rbtree_inline_insert(Eina_Rbtree *root, Eina_Rbt
167/** 167/**
168 * @brief Removes a node from an existing red black tree. 168 * @brief Removes a node from an existing red black tree.
169 * 169 *
170 * @param root The root of a valid red black tree. 170 * @param[in,out] root The root of a valid red black tree.
171 * @param node The node to remove from the tree. 171 * @param[in] node The node to remove from the tree.
172 * @param cmp The callback that is able to compare two nodes. 172 * @param[in] cmp The callback that is able to compare two nodes.
173 * @param data Private data to help the compare function. 173 * @param[in] data Private data to help the compare function.
174 * @return The new root of the red black tree. 174 * @return The new root of the red black tree.
175 * 175 *
176 * This function removes a new node in a valid red black tree that should 176 * This function removes a new node in a valid red black tree that should
@@ -182,20 +182,20 @@ EAPI Eina_Rbtree *eina_rbtree_inline_remove(Eina_Rbtree *root, Eina_Rbt
182/** 182/**
183 * @brief Deletes all nodes from a valid red black tree. 183 * @brief Deletes all nodes from a valid red black tree.
184 * 184 *
185 * @param root The root of a valid red black tree. 185 * @param[in,out] root The root of a valid red black tree.
186 * @param func The callback that will free each node. 186 * @param[in] func The callback that will free each node.
187 * @param data Private data to help the compare function. 187 * @param[in] data Private data to help the compare function.
188 */ 188 */
189EAPI void eina_rbtree_delete(Eina_Rbtree *root, Eina_Rbtree_Free_Cb func, void *data) EINA_ARG_NONNULL(2); 189EAPI void eina_rbtree_delete(Eina_Rbtree *root, Eina_Rbtree_Free_Cb func, void *data) EINA_ARG_NONNULL(2);
190 190
191/** 191/**
192 * @brief Searches tree for a key using a comparison function. 192 * @brief Searches tree for a key using a comparison function.
193 * 193 *
194 * @param root The root of a valid red black tree. 194 * @param[in,out] root The root of a valid red black tree.
195 * @param key The key value to search for. 195 * @param[in] key The key value to search for.
196 * @param length The length of the specified key. 196 * @param[in] length The length of the specified key.
197 * @param cmp Callback routine to compare two nodes. 197 * @param[in] cmp Callback routine to compare two nodes.
198 * @param data Private data to help the compare function. 198 * @param[in] data Private data to help the compare function.
199 * 199 *
200 * @return The first matching node found in the red black tree, or 200 * @return The first matching node found in the red black tree, or
201 * @p root if nothing was found. 201 * @p root if nothing was found.
@@ -206,7 +206,7 @@ static inline Eina_Rbtree *eina_rbtree_inline_lookup(const Eina_Rbtree *root, co
206/** 206/**
207 * @brief Returns a new prefix iterator associated with a rbtree. 207 * @brief Returns a new prefix iterator associated with a rbtree.
208 * 208 *
209 * @param root The root of rbtree. 209 * @param[in] root The root of rbtree.
210 * @return A new iterator. 210 * @return A new iterator.
211 * 211 *
212 * This function returns a newly allocated iterator associated with @p 212 * This function returns a newly allocated iterator associated with @p
@@ -226,7 +226,7 @@ EAPI Eina_Iterator *eina_rbtree_iterator_prefix(const Eina_Rbtree *root)
226/** 226/**
227 * @brief Returns a new prefix iterator associated with a rbtree. 227 * @brief Returns a new prefix iterator associated with a rbtree.
228 * 228 *
229 * @param root The root of rbtree. 229 * @param[in] root The root of rbtree.
230 * @return A new iterator. 230 * @return A new iterator.
231 * 231 *
232 * This function returns a newly allocated iterator associated with @p 232 * This function returns a newly allocated iterator associated with @p
@@ -246,7 +246,7 @@ EAPI Eina_Iterator *eina_rbtree_iterator_infix(const Eina_Rbtree *root) E
246/** 246/**
247 * @brief Returns a new prefix iterator associated with a rbtree. 247 * @brief Returns a new prefix iterator associated with a rbtree.
248 * 248 *
249 * @param root The root of rbtree. 249 * @param[in] root The root of rbtree.
250 * @return A new iterator. 250 * @return A new iterator.
251 * 251 *
252 * This function returns a newly allocated iterator associated with @p 252 * This function returns a newly allocated iterator associated with @p