jpeg pushed a commit to branch master.

http://git.enlightenment.org/core/efl.git/commit/?id=d0ded365e9d8b06c89c9f18f6a56709d705e62d6

commit d0ded365e9d8b06c89c9f18f6a56709d705e62d6
Author: Bryce Harrington <[email protected]>
Date:   Mon Nov 13 12:04:39 2017 +0900

    eina: Add API doxygen for eina_rbtree_inline_lookup()
    
    Reviewers: cedric, ajwillia.ms
    
    Subscribers: segfaultxavi, jpeg
    
    Differential Revision: https://phab.enlightenment.org/D5460
---
 src/lib/eina/eina_inline_rbtree.x |  2 +-
 src/lib/eina/eina_rbtree.h        | 13 ++++++++++++-
 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 @@
 /**
  * @addtogroup Eina_Rbtree_Group Red-Black tree
  *
- * @brief These functions provide Red-Black trees management.
+ * @brief These functions provide Red-Black tree management.
  *
  * @{
  */
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
  * @param root The root of a valid red black tree.
  * @param func The callback that will free each node.
  * @param data Private data to help the compare function.
- *
  */
 EAPI void                  eina_rbtree_delete(Eina_Rbtree *root, 
Eina_Rbtree_Free_Cb func, void *data) EINA_ARG_NONNULL(2);
 
+/**
+ * @brief Searches tree for a key using a comparison function.
+ *
+ * @param root The root of a valid red black tree.
+ * @param key The key value to search for.
+ * @param length The length of the specified key.
+ * @param cmp Callback routine to compare two nodes.
+ * @param data Private data to help the compare function.
+ *
+ * @return The first matching node found in the red black tree, or
+ * @p root if nothing was found.
+ */
 static 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;
 
 

-- 


Reply via email to