summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorBryce Harrington <bryce@osg.samsung.com>2017-11-13 12:04:39 +0900
committerJean-Philippe Andre <jp.andre@samsung.com>2017-11-13 12:04:39 +0900
commitd0ded365e9d8b06c89c9f18f6a56709d705e62d6 (patch)
tree8e86dc2e3970229f0ab95e352c9747b3ff9a7882 /src
parent3830cbaa25329b94252eccc7ac00449d023d5a6b (diff)
eina: Add API doxygen for eina_rbtree_inline_lookup()
Reviewers: cedric, ajwillia.ms Subscribers: segfaultxavi, jpeg Differential Revision: https://phab.enlightenment.org/D5460
Diffstat (limited to 'src')
-rw-r--r--src/lib/eina/eina_inline_rbtree.x2
-rw-r--r--src/lib/eina/eina_rbtree.h13
2 files changed, 13 insertions, 2 deletions
diff --git a/src/lib/eina/eina_inline_rbtree.x b/src/lib/eina/eina_inline_rbtree.x
index 6ebbb98642..b97e5944af 100644
--- a/src/lib/eina/eina_inline_rbtree.x
+++ b/src/lib/eina/eina_inline_rbtree.x
@@ -22,7 +22,7 @@
22/** 22/**
23 * @addtogroup Eina_Rbtree_Group Red-Black tree 23 * @addtogroup Eina_Rbtree_Group Red-Black tree
24 * 24 *
25 * @brief These functions provide Red-Black trees management. 25 * @brief These functions provide Red-Black tree management.
26 * 26 *
27 * @{ 27 * @{
28 */ 28 */
diff --git a/src/lib/eina/eina_rbtree.h b/src/lib/eina/eina_rbtree.h
index 5f1e085ac0..fad916aa66 100644
--- a/src/lib/eina/eina_rbtree.h
+++ b/src/lib/eina/eina_rbtree.h
@@ -184,10 +184,21 @@ EAPI Eina_Rbtree *eina_rbtree_inline_remove(Eina_Rbtree *root, Eina_Rbt
184 * @param root The root of a valid red black tree. 184 * @param root The root of a valid red black tree.
185 * @param func The callback that will free each node. 185 * @param func The callback that will free each node.
186 * @param data Private data to help the compare function. 186 * @param data Private data to help the compare function.
187 *
188 */ 187 */
189EAPI void eina_rbtree_delete(Eina_Rbtree *root, Eina_Rbtree_Free_Cb func, void *data) EINA_ARG_NONNULL(2); 188EAPI void eina_rbtree_delete(Eina_Rbtree *root, Eina_Rbtree_Free_Cb func, void *data) EINA_ARG_NONNULL(2);
190 189
190/**
191 * @brief Searches tree for a key using a comparison function.
192 *
193 * @param root The root of a valid red black tree.
194 * @param key The key value to search for.
195 * @param length The length of the specified key.
196 * @param cmp Callback routine to compare two nodes.
197 * @param data Private data to help the compare function.
198 *
199 * @return The first matching node found in the red black tree, or
200 * @p root if nothing was found.
201 */
191static inline Eina_Rbtree *eina_rbtree_inline_lookup(const Eina_Rbtree *root, const void *key, int length, Eina_Rbtree_Cmp_Key_Cb cmp, const void *data) EINA_PURE EINA_ARG_NONNULL(2, 4) EINA_WARN_UNUSED_RESULT; 202static inline Eina_Rbtree *eina_rbtree_inline_lookup(const Eina_Rbtree *root, const void *key, int length, Eina_Rbtree_Cmp_Key_Cb cmp, const void *data) EINA_PURE EINA_ARG_NONNULL(2, 4) EINA_WARN_UNUSED_RESULT;
192 203
193 204