Enlightenment CVS committal
Author : ncn
Project : e17
Module : libs/ecore
Dir : e17/libs/ecore/src/lib/ecore
Modified Files:
ecore_hash.c ecore_list.c
Log Message:
More docs stuff - fix ups, rearranging, little bit o' new stuff, quieter doc
generation.
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ecore/src/lib/ecore/ecore_hash.c,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -3 -r1.4 -r1.5
--- ecore_hash.c 1 May 2004 17:30:34 -0000 1.4
+++ ecore_hash.c 30 Jul 2004 12:28:29 -0000 1.5
@@ -29,12 +29,18 @@
static int _ecore_hash_node_destroy(Ecore_Hash_Node *node, Ecore_Free_Cb keyd,
Ecore_Free_Cb valued);
+/**
+ * @defgroup Ecore_Data_Hash_ADT_Creation_Group Hash Creation Functions
+ *
+ * Functions that create hash tables.
+ */
/**
- * @brief Create and initialize a new hash
- * @param hash_func: the function for determining hash position
- * @param compare: the function for comparing node keys
- * @return Returns NULL on error, a new hash on success
+ * Creates and initializes a new hash
+ * @param hash_func The function for determining hash position.
+ * @param compare The function for comparing node keys.
+ * @return @c NULL on error, a new hash on success.
+ * @ingroup Ecore_Data_Hash_ADT_Creation_Group
*/
Ecore_Hash *ecore_hash_new(Ecore_Hash_Cb hash_func, Ecore_Compare_Cb compare)
{
@@ -51,11 +57,12 @@
}
/**
- * @brief Initialize a hash to some sane starting values
- * @param hash: the hash table to initialize
- * @param hash_func: the function for hashing node keys
- * @param compare: the function for comparing node keys
- * @return Returns TRUE on success, FALSE on an error.
+ * Initializes the given hash.
+ * @param hash The given hash.
+ * @param hash_func The function used for hashing node keys.
+ * @param compare The function used for comparing node keys.
+ * @return @c TRUE on success, @c FALSE on an error.
+ * @ingroup Ecore_Data_Hash_ADT_Creation_Group
*/
int ecore_hash_init(Ecore_Hash *hash, Ecore_Hash_Cb hash_func, Ecore_Compare_Cb
compare)
{
@@ -76,10 +83,17 @@
}
/**
- * @brief Set the function to destroy the keys of entries
- * @param hash: the hash that this will affect
- * @param function: the function that will free the node keys
- * @return Returns TRUE on success, FALSE on error
+ * @defgroup Ecore_Data_Hash_ADT_Destruction_Group Hash Destruction Functions
+ *
+ * Functions that destroy hash tables and their contents.
+ */
+
+/**
+ * Sets the function to destroy the keys of the given hash.
+ * @param hash The given hash.
+ * @param function The function used to free the node keys.
+ * @return @c TRUE on success, @c FALSE on error.
+ * @ingroup Ecore_Data_Hash_ADT_Destruction_Group
*/
int ecore_hash_set_free_key(Ecore_Hash *hash, Ecore_Free_Cb function)
{
@@ -94,10 +108,11 @@
}
/**
- * @brief Set the function to destroy the value
- * @param hash: the hash that this will affect
- * @param function: the function that will free the node values
- * @return Returns TRUE on success, FALSE on error
+ * Sets the function to destroy the values in the given hash.
+ * @param hash The given hash.
+ * @param function The function that will free the node values.
+ * @return @c TRUE on success, @c FALSE on error
+ * @ingroup Ecore_Data_Hash_ADT_Destruction_Group
*/
int ecore_hash_set_free_value(Ecore_Hash *hash, Ecore_Free_Cb function)
{
@@ -112,11 +127,18 @@
}
/**
- * @brief Set the key/value pair in the hash table
- * @param hash: the hash table to set the the value in
- * @param key: the key for this value pair
- * @param value: the value corresponding with the key
- * @return Returns TRUE if successful, FALSE if not
+ * @defgroup Ecore_Data_Hash_ADT_Setting_Group Hash Setting Functions
+ *
+ * Functions that set values in hash tables.
+ */
+
+/**
+ * Sets a key-value pair in the given hash table.
+ * @param hash The given hash table.
+ * @param key The key.
+ * @param value The value.
+ * @return @c TRUE if successful, @c FALSE if not.
+ * @ingroup Ecore_Data_Hash_ADT_Setting_Group
*/
int ecore_hash_set(Ecore_Hash *hash, void *key, void *value)
{
@@ -140,9 +162,10 @@
}
/**
- * @brief Free the hash table and the data contained inside it
- * @param hash: the hash table to destroy
- * @return Returns TRUE on success, FALSE on error
+ * Free 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
*/
void ecore_hash_destroy(Ecore_Hash *hash)
{
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ecore/src/lib/ecore/ecore_list.c,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -3 -r1.9 -r1.10
--- ecore_list.c 22 Jul 2004 13:07:24 -0000 1.9
+++ ecore_list.c 30 Jul 2004 12:28:29 -0000 1.10
@@ -202,6 +202,12 @@
/* XXX: End deprecated code */
/**
[EMAIL PROTECTED] Ecore_Data_List_Creation_Group List Creation/Destruction Functions
+
+Functions that create, initialize and destroy Ecore_Lists.
+*/
+
+/**
* Create and initialize a new list.
* @return A new initialized list on success, @c NULL on failure.
* @ingroup Ecore_Data_List_Creation_Group
@@ -346,6 +352,12 @@
}
/**
[EMAIL PROTECTED] Ecore_Data_List_Add_Item_Group List Item Adding Functions
+
+Functions that are used to add nodes to an Ecore_List.
+*/
+
+/**
* Append data to the list.
* @param list The list.
* @param data The data to append.
@@ -500,6 +512,12 @@
}
/**
[EMAIL PROTECTED] Ecore_Data_List_Remove_Item_Group List Item Removing Functions
+
+Functions that remove nodes from an Ecore_List.
+*/
+
+/**
* Remove the current item from the list.
* @param list The list to remove the current item
* @return A pointer to the removed data on success, @c NULL on failure.
@@ -709,6 +727,12 @@
}
/**
[EMAIL PROTECTED] Ecore_Data_List_Traverse_Group List Traversal Functions
+
+Functions that can be used to traverse an Ecore_List.
+*/
+
+/**
* Make the current item the item with the given index number.
* @param list The list.
* @param index The position to move the current item.
@@ -1020,7 +1044,14 @@
}
/**
- * Allocate and initialize a new list node
[EMAIL PROTECTED] Ecore_Data_List_Node_Group List Node Functions
+
+Functions that are used in the creation, maintenance and destruction of
+Ecore_List nodes.
+*/
+
+/**
+ * Allocates and initializes a new list node.
* @return A new Ecore_List_Node on success, @c NULL otherwise.
* @ingroup Ecore_Data_List_Node_Group
*/
@@ -1039,7 +1070,7 @@
}
/**
- * Here we actually call the function to free the data and free the node
+ * Calls the function to free the data and the node.
* @param node Node to destroy.
* @param free_func Function to call if @p node points to data to free.
* @return @c TRUE.
-------------------------------------------------------
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
