From 7550af0970f8041054f25c3068771d7a3217115e Mon Sep 17 00:00:00 2001 From: jihoon Date: Thu, 5 Apr 2012 03:52:51 +0000 Subject: [PATCH] =?utf8?q?eina:=20fix=20doc=20return=20type=20Sign-Off=20B?= =?utf8?q?y:=20J=C3=A9r=C3=B4me=20Pinot?= MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit git-svn-id: svn+ssh://svn.enlightenment.org/var/svn/e/trunk/eina@69924 7cbeb6ba-43b4-40fd-8cce-4c39aea84d33 --- src/include/eina_file.h | 2 ++ src/include/eina_mmap.h | 1 + src/include/eina_module.h | 9 ++++----- src/include/eina_prefix.h | 15 +++++---------- src/include/eina_tiler.h | 1 + src/include/eina_value.h | 4 ++++ 6 files changed, 17 insertions(+), 15 deletions(-) diff --git a/src/include/eina_file.h b/src/include/eina_file.h index 1af22af..0110ea7 100644 --- a/src/include/eina_file.h +++ b/src/include/eina_file.h @@ -348,6 +348,7 @@ EAPI char *eina_file_path_sanitize(const char *path); * * @param name Filename to open * @param shared Requested a shm + * @return Eina_File handle to the file * * Opens a file in read-only mode. @p name should be an absolute path. An * Eina_File handle can be shared among multiple instances if @p shared is @@ -467,6 +468,7 @@ EAPI void eina_file_map_free(Eina_File *file, void *map); * * @param file The file handler to the mmaped file. * @param map Memory map to check if an error occured on it. + * @return #EINA_TRUE if there was an IO error, #EINA_FALSE otherwise. * * @since 1.2 */ diff --git a/src/include/eina_mmap.h b/src/include/eina_mmap.h index 8c38ce1..b87ecc8 100644 --- a/src/include/eina_mmap.h +++ b/src/include/eina_mmap.h @@ -15,6 +15,7 @@ * @brief Enable or disable safe mmaped IO handling * * @param enabled The enabled state (to enable, pass EINA_TRUE) + * @return #EINA_TRUE on success, #EINA_FALSE on failure. * * This enables (if possible on your platform) a signal handler for * SIGBUS, that replaces the "bad page" with a pzge of 0's (from /dev/zero) diff --git a/src/include/eina_module.h b/src/include/eina_module.h index 178fa9a..496a01c 100644 --- a/src/include/eina_module.h +++ b/src/include/eina_module.h @@ -122,11 +122,10 @@ extern EAPI Eina_Error EINA_ERROR_MODULE_INIT_FAILED; * @brief Return a new module. * * @param file The name of the file module to load. - * - * This function returns a new module. If @p file is @c NULL, the - * function returns @c NULL, otherwise, it allocates an Eina_Module, - * stores a duplicate string of @p file, sets its reference to @c 0 - * and its handle to @c NULL. + * @return A new module. If @p file is @c NULL, the function + * returns @c NULL, otherwise, it allocates an Eina_Module, stores + * a duplicate string of @p file, sets its reference to @c 0 and + * its handle to @c NULL. * * When the new module is not needed anymore, use eina_module_free() * to free the allocated memory. diff --git a/src/include/eina_prefix.h b/src/include/eina_prefix.h index b59080b..9e26703 100644 --- a/src/include/eina_prefix.h +++ b/src/include/eina_prefix.h @@ -161,8 +161,7 @@ eina_prefix_free(Eina_Prefix *pfx); * @brief Get the prefix base directory * * @param pfx The prefix object - * - * This returns the base prefix (eg "/usr/local", "/usr", "/opt/appname" or + * @return The base prefix (eg "/usr/local", "/usr", "/opt/appname" or * "/home/user/myapps/appname" etc.) that the software resides in at runtime. * * @since 1.1.0 @@ -174,8 +173,7 @@ eina_prefix_get(Eina_Prefix *pfx); * @brief Get the binary installation directory * * @param pfx The prefix object - * - * This returns the location of installed binaries (eg "/usr/local/bin", + * @return The location of installed binaries (eg "/usr/local/bin", * "/usr/bin", "/opt/appname/bin", "/home/user/myapps/appname/bin" etc.). * * @since 1.1.0 @@ -187,8 +185,7 @@ eina_prefix_bin_get(Eina_Prefix *pfx); * @brief Get the library installation directory * * @param pfx The prefix object - * - * This returns the location of installed binaries (eg "/usr/local/lib", + * @return The location of installed binaries (eg "/usr/local/lib", * "/usr/lib32", "/opt/appname/lib64", "/home/user/myapps/appname/lib" etc.). * * @since 1.1.0 @@ -200,8 +197,7 @@ eina_prefix_lib_get(Eina_Prefix *pfx); * @brief Get the data installation directory * * @param pfx The prefix object - * - * This returns the location of installed binaries (eg "/usr/local/share/appname", + * @return The location of installed binaries (eg "/usr/local/share/appname", * "/usr/share/appname", "/opt/appname/share/appname", "/home/user/myapps/appname/share/appname" etc.). * * @since 1.1.0 @@ -213,8 +209,7 @@ eina_prefix_data_get(Eina_Prefix *pfx); * @brief Get the locale installation directory * * @param pfx The prefix object - * - * This returns the location of installed binaries (eg "/usr/local/share/locale", + * @return The location of installed binaries (eg "/usr/local/share/locale", * "/usr/share/locale", "/opt/appname/share/locale", "/home/user/myapps/appname/share/locale" etc.). * * @since 1.1.0 diff --git a/src/include/eina_tiler.h b/src/include/eina_tiler.h index d7e1bc8..4b5ea15 100644 --- a/src/include/eina_tiler.h +++ b/src/include/eina_tiler.h @@ -210,6 +210,7 @@ EAPI void eina_tiler_tile_size_set(Eina_Tiler *t, int w, int h); * * @param t The tiler in which to add a container. * @param r The rectangle to be added. + * @return #EINA_TRUE on success, #EINA_FALSE on failure. * * @see eina_tiler_rect_del() */ diff --git a/src/include/eina_value.h b/src/include/eina_value.h index 05d0f46..2ef89ff 100644 --- a/src/include/eina_value.h +++ b/src/include/eina_value.h @@ -3314,6 +3314,7 @@ static inline Eina_Bool eina_value_struct_pget(const Eina_Value *value, * @param src source value object * @param name name to find the member * @param dst where to return the member value. + * @return #EINA_TRUE on success, #EINA_FALSE on failure. * * The argument @a dst is considered uninitialized and it's setup to * the type of the member. @@ -3329,6 +3330,7 @@ static inline Eina_Bool eina_value_struct_value_get(const Eina_Value *src, * @param dst destination value object * @param name name to find the member * @param src source value + * @return #EINA_TRUE on success, #EINA_FALSE on failure. * * @since 1.2 */ @@ -3341,6 +3343,7 @@ static inline Eina_Bool eina_value_struct_value_set(Eina_Value *dst, * @param src source value object * @param member the member description to use * @param dst where to return the member value. + * @return #EINA_TRUE on success, #EINA_FALSE on failure. * * The argument @a dst is considered uninitialized and it's setup to * the type of the member. @@ -3356,6 +3359,7 @@ static inline Eina_Bool eina_value_struct_member_value_get(const Eina_Value *src * @param dst destination value object * @param member the member description to use * @param src source value + * @return #EINA_TRUE on success, #EINA_FALSE on failure. * * @since 1.2 */ -- 2.7.4