Enlightenment CVS committal
Author : ncn
Project : e17
Module : libs/ecore
Dir : e17/libs/ecore/src/lib/ecore
Modified Files:
ecore_hash.c
Log Message:
Basically clean-up, simplification, created a few more modules and inserted a doc bug
or two.
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ecore/src/lib/ecore/ecore_hash.c,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -3 -r1.5 -r1.6
--- ecore_hash.c 30 Jul 2004 12:28:29 -0000 1.5
+++ ecore_hash.c 1 Aug 2004 12:48:26 -0000 1.6
@@ -127,9 +127,9 @@
}
/**
- * @defgroup Ecore_Data_Hash_ADT_Setting_Group Hash Setting Functions
+ * @defgroup Ecore_Data_Hash_ADT_Data_Group Hash Data Functions
*
- * Functions that set values in hash tables.
+ * Functions that set, access and delete values from the hash tables.
*/
/**
@@ -138,7 +138,7 @@
* @param key The key.
* @param value The value.
* @return @c TRUE if successful, @c FALSE if not.
- * @ingroup Ecore_Data_Hash_ADT_Setting_Group
+ * @ingroup Ecore_Data_Hash_ADT_Data_Group
*/
int ecore_hash_set(Ecore_Hash *hash, void *key, void *value)
{
@@ -162,7 +162,7 @@
}
/**
- * Free the hash table and the data contained inside it.
+ * Frees the hash table and the data contained inside it.
* @param hash The hash table to destroy.
* @return @c TRUE on success, @c FALSE on error.
* @ingroup Ecore_Data_Hash_ADT_Destruction_Group
@@ -193,10 +193,17 @@
}
/**
- * @brief Iterate over the entries in the hash table
- * @param hash: the hash whose entries are iterated over
- * @param for_each_func: the function each entry is passed to
- * @return Returns TRUE on success, FALSE otherwise.
+ * @defgroup Ecore_Data_Hash_ADT_Traverse_Group Hash Traverse Functions
+ *
+ * Functions that iterate through hash tables.
+ */
+
+/**
+ * Runs the @p for_each_func function on each entry in the given hash.
+ * @param hash The given hash.
+ * @param for_each_func The function that each entry is passed to.
+ * @return TRUE on success, FALSE otherwise.
+ * @ingroup Ecore_Data_Hash_ADT_Traverse_Group
*/
int ecore_hash_for_each_node(Ecore_Hash *hash, Ecore_For_Each for_each_func)
{
@@ -225,10 +232,8 @@
}
/**
- * @brief Print the distribution of the hash table for graphing
- * @param hash: the hash table to print
- *
- * Returns no value.
+ * Prints the distribution of the given hash table for graphing.
+ * @param hash The given hash table.
*/
void
ecore_hash_dump_graph(Ecore_Hash *hash)
@@ -295,11 +300,12 @@
}
/**
- * @brief Retrieve the value associated with key
- * @param hash: the hash table to search for the key
- * @param key: the key to search for in the hash table
- *
- * @return Returns NULL on error, value corresponding to key on success
+ * Retrieves the value associated with the given key from the given hash
+ * table.
+ * @param hash The given hash table.
+ * @param key The key to search for.
+ * @return The value corresponding to key on success, @c NULL otherwise.
+ * @ingroup Ecore_Data_Hash_ADT_Data_Group
*/
void *ecore_hash_get(Ecore_Hash *hash, void *key)
{
@@ -321,11 +327,13 @@
/**
- * @brief Remove the value associated with key
- * @param hash: the hash table to remove the key from
- * @param key: the key to search for in the hash table
- *
- * @return Returns NULL on error, value corresponding to key on success
+ * Removes the value associated with the given key in the given hash
+ * table.
+ * @param hash The given hash table.
+ * @param key The key to search for.
+ * @return The value corresponding to the key on success. @c NULL is
+ * returned if there is an error.
+ * @ingroup Ecore_Data_Hash_ADT_Data_Group
*/
void *ecore_hash_remove(Ecore_Hash *hash, void *key)
{
-------------------------------------------------------
This SF.Net email is sponsored by OSTG. Have you noticed the changes on
Linux.com, ITManagersJournal and NewsForge in the past few weeks? Now,
one more big change to announce. We are now OSTG- Open Source Technology
Group. Come see the changes on the new OSTG site. www.ostg.com
_______________________________________________
enlightenment-cvs mailing list
[EMAIL PROTECTED]
https://lists.sourceforge.net/lists/listinfo/enlightenment-cvs
