Enlightenment CVS committal
Author : doursse
Project : e17
Module : proto/eina
Dir : e17/proto/eina/src/lib
Modified Files:
eina_error.c eina_file.c eina_hash.c eina_stringshare.c
Log Message:
fix doxy doc
===================================================================
RCS file: /cvs/e/e17/proto/eina/src/lib/eina_error.c,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -3 -r1.8 -r1.9
--- eina_error.c 8 Aug 2008 12:29:13 -0000 1.8
+++ eina_error.c 9 Aug 2008 05:47:15 -0000 1.9
@@ -104,7 +104,7 @@
/**
* Register a new error type
- * @param str The description of the error
+ * @param msg The description of the error
* @return The unique number identifier for this error
*/
EAPI Eina_Error eina_error_register(const char *msg)
===================================================================
RCS file: /cvs/e/e17/proto/eina/src/lib/eina_file.c,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -3 -r1.3 -r1.4
--- eina_file.c 6 Aug 2008 18:15:19 -0000 1.3
+++ eina_file.c 9 Aug 2008 05:47:15 -0000 1.4
@@ -21,12 +21,17 @@
#include "eina_file.h"
#include "eina_private.h"
+
/*============================================================================*
* API
*
*============================================================================*/
+
/**
* Lis all files on the directory calling the function for every file found
+ * @param dir The directory name
* @param recursive Iterate recursively in the directory
+ * @param cb The callback to be called
+ * @param data The data to pass to the callback
*/
EAPI void eina_file_dir_list(const char *dir, int recursive,
Eina_File_Dir_List_Cb cb, void *data)
{
===================================================================
RCS file: /cvs/e/e17/proto/eina/src/lib/eina_hash.c,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -3 -r1.5 -r1.6
--- eina_hash.c 7 Aug 2008 13:11:13 -0000 1.5
+++ eina_hash.c 9 Aug 2008 05:47:15 -0000 1.6
@@ -203,7 +203,7 @@
*
* @param hash The given hash table. Can be @c NULL.
* @param key A unique key. Can be @c NULL.
- * @param key_length Should be the length of @p key (don't forget to count
'\0' for string).
+ * @param key_length Should be the length of @p key (don't forget to count
'\\0' for string).
* @param key_hash The hash that will always match key.
* @param data Data to associate with the string given by @p key.
* @return Will return EINA_FALSE if an error occured, and EINA_TRUE if every
@@ -262,7 +262,7 @@
*
* @param hash The given hash table. Can be @c NULL.
* @param key A unique key. Can be @c NULL.
- * @param key_length Should be the length of @p key (don't forget to count
'\0' for string).
+ * @param key_length Should be the length of @p key (don't forget to count
'\\0' for string).
* @param key_hash The hash that will always match key.
* @param data Data to associate with the string given by @p key.
* @return Will return EINA_FALSE if an error occured, and EINA_TRUE if every
@@ -311,7 +311,7 @@
*
* Key strings are case sensitive.
*
- * @ref eina_hash_alloc_error should be used to determine if an
+ * @ref eina_error_get() should be used to determine if an
* allocation error occurred during this function.
*
* @param hash The given hash table. Can be @c NULL.
@@ -346,7 +346,7 @@
*
* Key strings are case sensitive.
*
- * @ref eina_hash_alloc_error should be used to determine if an
+ * @ref eina_error_get() should be used to determine if an
* allocation error occurred during this function.
*
* @param hash The given hash table. Can be @c NULL.
@@ -379,6 +379,7 @@
*
* @param hash The given hash table.
* @param key The key. Can be @c NULL.
+ * @param key_length Should be the length of @p key (don't forget to count
'\\0' for string).
* @param key_hash The hash that always match the key. Ignored if @p key is
@c NULL.
* @param data The data pointer to remove if @p key is @c NULL.
* Otherwise, not required and can be @c NULL.
@@ -441,6 +442,7 @@
* Retrieves a specific entry in the given hash table.
* @param hash The given hash table.
* @param key The key of the entry to find.
+ * @param key_length Should be the length of @p key (don't forget to count
'\\0' for string).
* @param key_hash The hash that always match the key. Ignored if @p key is
@c NULL.
* @return The data pointer for the stored entry, or @c NULL if not
* found.
@@ -488,6 +490,7 @@
* Modifies the entry pointer at the specified key and returns the old entry
* @param hash The given hash table.
* @param key The key of the entry to modify.
+ * @param key_length Should be the length of @p key (don't forget to count
'\\0' for string).
* @param key_hash The hash that always match the key. Ignored if @p key is
@c NULL.
* @param data The data to replace the old entry, if it exists.
* @return The data pointer for the old stored entry, or @c NULL if not
@@ -556,11 +559,6 @@
if (!hash) return 0;
return hash->population;
}
-
-/**
- * @todo Complete polishing documentation for eina_hash.c. The
- * functions' docs may be grouped, but they need some simplification.
- */
/**
* Free an entire hash table
===================================================================
RCS file: /cvs/e/e17/proto/eina/src/lib/eina_stringshare.c,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -3 -r1.8 -r1.9
--- eina_stringshare.c 8 Aug 2008 16:07:32 -0000 1.8
+++ eina_stringshare.c 9 Aug 2008 05:47:15 -0000 1.9
@@ -170,7 +170,7 @@
*
* It will free the string if no other instances are left.
*
- * @param string The given string.
+ * @param str string The given string.
* @ingroup Eina_Stringshare_Group
*/
EAPI void
-------------------------------------------------------------------------
This SF.Net email is sponsored by the Moblin Your Move Developer's challenge
Build the coolest Linux based applications with Moblin SDK & win great prizes
Grand prize is a trip for two to an Open Source event anywhere in the world
http://moblin-contest.org/redirect.php?banner_id=100&url=/
_______________________________________________
enlightenment-cvs mailing list
enlightenment-cvs@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/enlightenment-cvs
