From bbf9b05530bea0fdf129eeb6f75a6554e02a0658 Mon Sep 17 00:00:00 2001 From: doursse Date: Sat, 9 Aug 2008 05:47:15 +0000 Subject: [PATCH] fix doxy doc SVN revision: 35416 --- legacy/eina/src/lib/eina_error.c | 2 +- legacy/eina/src/lib/eina_file.c | 5 +++++ legacy/eina/src/lib/eina_hash.c | 16 +++++++--------- legacy/eina/src/lib/eina_stringshare.c | 2 +- 4 files changed, 14 insertions(+), 11 deletions(-) diff --git a/legacy/eina/src/lib/eina_error.c b/legacy/eina/src/lib/eina_error.c index 04ab5dc168..877adc495b 100644 --- a/legacy/eina/src/lib/eina_error.c +++ b/legacy/eina/src/lib/eina_error.c @@ -104,7 +104,7 @@ EAPI int eina_error_shutdown(void) /** * 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) diff --git a/legacy/eina/src/lib/eina_file.c b/legacy/eina/src/lib/eina_file.c index f45d12f65d..87e36dfcd3 100644 --- a/legacy/eina/src/lib/eina_file.c +++ b/legacy/eina/src/lib/eina_file.c @@ -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) { diff --git a/legacy/eina/src/lib/eina_hash.c b/legacy/eina/src/lib/eina_hash.c index 7c1c655ca6..310f168674 100644 --- a/legacy/eina/src/lib/eina_hash.c +++ b/legacy/eina/src/lib/eina_hash.c @@ -203,7 +203,7 @@ eina_hash_string_superfast_new(void) * * @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 @@ eina_hash_add_by_hash(Eina_Hash *hash, * * @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 @@ eina_hash_direct_add_by_hash(Eina_Hash *hash, * * 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 @@ eina_hash_add(Eina_Hash *hash, const void *key, const void *data) * * 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 @@ eina_hash_direct_add(Eina_Hash *hash, const void *key, const void *data) * * @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 @@ eina_hash_del(Eina_Hash *hash, const void *key, const void *data) * 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 @@ eina_hash_find(const Eina_Hash *hash, const void *key) * 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 @@ -557,11 +560,6 @@ eina_hash_population(const Eina_Hash *hash) 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 * @param hash The hash table to be freed diff --git a/legacy/eina/src/lib/eina_stringshare.c b/legacy/eina/src/lib/eina_stringshare.c index b8d4184a14..303079402c 100644 --- a/legacy/eina/src/lib/eina_stringshare.c +++ b/legacy/eina/src/lib/eina_stringshare.c @@ -170,7 +170,7 @@ eina_stringshare_add(const char *str) * * 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