Hi, This patch fixes all the missing return types of functions in eina doc:
/tmp/eina/src/include/eina_module.h:121: warning: return type of member eina_module_new is not documented /tmp/eina/src/include/eina_tiler.h:208: warning: return type of member eina_tiler_rect_add is not documented /tmp/eina/src/include/eina_value.h:3312: warning: return type of member eina_value_struct_value_get is not documented /tmp/eina/src/include/eina_value.h:3327: warning: return type of member eina_value_struct_value_set is not documented /tmp/eina/src/include/eina_value.h:3339: warning: return type of member eina_value_struct_member_value_get is not documented /tmp/eina/src/include/eina_value.h:3354: warning: return type of member eina_value_struct_member_value_set is not documented /tmp/eina/src/include/eina_file.h:346: warning: return type of member eina_file_open is not documented /tmp/eina/src/include/eina_file.h:465: warning: return type of member eina_file_map_faulted is not documented /tmp/eina/src/include/eina_mmap.h:14: warning: return type of member eina_mmap_safety_enabled_set is not documented /tmp/eina/src/include/eina_prefix.h:160: warning: return type of member eina_prefix_get is not documented /tmp/eina/src/include/eina_prefix.h:173: warning: return type of member eina_prefix_bin_get is not documented /tmp/eina/src/include/eina_prefix.h:186: warning: return type of member eina_prefix_lib_get is not documented /tmp/eina/src/include/eina_prefix.h:199: warning: return type of member eina_prefix_data_get is not documented /tmp/eina/src/include/eina_prefix.h:212: warning: return type of member eina_prefix_locale_get is not documented -- Jérôme Pinot http://ngc891.blogdns.net/
Index: eina/src/include/eina_prefix.h =================================================================== --- eina/src/include/eina_prefix.h (revision 69923) +++ eina/src/include/eina_prefix.h (working copy) @@ -161,8 +161,7 @@ * @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 @@ * @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 @@ * @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 @@ * @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 @@ * @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 Index: eina/src/include/eina_file.h =================================================================== --- eina/src/include/eina_file.h (revision 69923) +++ eina/src/include/eina_file.h (working copy) @@ -348,6 +348,7 @@ * * @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 @@ * * @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 */ Index: eina/src/include/eina_tiler.h =================================================================== --- eina/src/include/eina_tiler.h (revision 69923) +++ eina/src/include/eina_tiler.h (working copy) @@ -210,6 +210,7 @@ * * @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() */ Index: eina/src/include/eina_mmap.h =================================================================== --- eina/src/include/eina_mmap.h (revision 69923) +++ eina/src/include/eina_mmap.h (working copy) @@ -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) Index: eina/src/include/eina_value.h =================================================================== --- eina/src/include/eina_value.h (revision 69923) +++ eina/src/include/eina_value.h (working copy) @@ -3314,6 +3314,7 @@ * @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 @@ * @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 @@ * @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 @@ * @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 */ Index: eina/src/include/eina_module.h =================================================================== --- eina/src/include/eina_module.h (revision 69923) +++ eina/src/include/eina_module.h (working copy) @@ -122,12 +122,11 @@ * @brief Return a new module. * * @param file The name of the file module to load. + * @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. * - * 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. - * * When the new module is not needed anymore, use eina_module_free() * to free the allocated memory. *
signature.asc
Description: Digital signature
------------------------------------------------------------------------------ Better than sec? Nothing is better than sec when it comes to monitoring Big Data applications. Try Boundary one-second resolution app monitoring today. Free. http://p.sf.net/sfu/Boundary-dev2dev
_______________________________________________ enlightenment-devel mailing list [email protected] https://lists.sourceforge.net/lists/listinfo/enlightenment-devel
