From: discomfitor <discomfitor@7cbeb6ba-43b4-40fd-8cce-4c39aea84d33>
Date: Fri, 30 Jul 2010 21:18:40 +0000 (+0000)
Subject: incomplete doxy!
X-Git-Tag: 2.0_alpha~70^2~452
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=f4a12bffd85143f5c14f84d2693d3dc746b7f075;p=framework%2Fuifw%2Feina.git

incomplete doxy!
cedric SPANK SPANK SPANK!!!


git-svn-id: svn+ssh://svn.enlightenment.org/var/svn/e/trunk/eina@50694 7cbeb6ba-43b4-40fd-8cce-4c39aea84d33
---

diff --git a/src/lib/eina_hash.c b/src/lib/eina_hash.c
index 490f11e..d896a38 100644
--- a/src/lib/eina_hash.c
+++ b/src/lib/eina_hash.c
@@ -1484,11 +1484,14 @@ eina_hash_modify(Eina_Hash *hash, const void *key, const void *data)
 }
 
 /**
- * Change the key associated with a data without trigerring the del callback.
+ * @brief Change the key associated with a data without triggering the free callback.
  * @param hash    The given hash table.
  * @param old_key The current key associated with the data
  * @param new_key The new key to associate data with
- * @return EINA_FALSE if somethings goes wrong.
+ * @return EINA_FALSE in any case but success, EINA_TRUE on success.
+ * This function allows for the move of data from one key to another,
+ * but does not call the Eina_Free_Cb associated with the hash table
+ * when destroying the old key.
  */
 EAPI Eina_Bool
 eina_hash_move(Eina_Hash *hash, const void *old_key, const void *new_key)