ajwillia-ms pushed a commit to branch master. http://git.enlightenment.org/core/efl.git/commit/?id=70f7f88eabf6c22e8cc1ac230a4b0851bda8c7c1
commit 70f7f88eabf6c22e8cc1ac230a4b0851bda8c7c1 Author: Bryce Harrington <[email protected]> Date: Tue Nov 7 08:59:02 2017 +0000 eina: Fix spelling errors in documentation (matrixsparse..module) Reviewers: cedric, ajwillia.ms Subscribers: segfaultxavi, jpeg Differential Revision: https://phab.enlightenment.org/D5425 --- src/lib/eina/eina_matrixsparse.h | 10 +++++----- src/lib/eina/eina_mmap.h | 2 +- src/lib/eina/eina_module.h | 26 +++++++++++++------------- 3 files changed, 19 insertions(+), 19 deletions(-) diff --git a/src/lib/eina/eina_matrixsparse.h b/src/lib/eina/eina_matrixsparse.h index 88c05264c7..6d1b98c9e9 100644 --- a/src/lib/eina/eina_matrixsparse.h +++ b/src/lib/eina/eina_matrixsparse.h @@ -96,7 +96,7 @@ EAPI Eina_Matrixsparse *eina_matrixsparse_new(unsigned long rows, const void *user_data); /** - * @brief Frees resources allocated to Sparse Matrix. + * @brief Frees resources allocated for Sparse Matrix. * * @param m The Sparse Matrix instance to free, must @b not be @c NULL. */ @@ -149,7 +149,7 @@ EAPI Eina_Bool eina_matrixsparse_size_set(Eina_Matrixsparse *m, * @param col The new number of column to clear. * @param cell Pointer to return cell reference, if any exists. * - * @return @c 1 on success, @c 0 on failure. It is considered success if did not + * @return @c 1 on success, @c 0 on failure. It is considered successful if did not * exist but index is inside matrix size, in this case @c *cell == NULL * * @see eina_matrixsparse_cell_data_get() @@ -272,7 +272,7 @@ EAPI Eina_Bool eina_matrixsparse_data_idx_set(Eina_Matrixsparse *m, unsigned lon * @param m The sparse matrix to operate on. * @param row The new number of row to clear. * - * @return #EINA_TRUE on success, #EINA_FALSE on failure. It is considered success if row + * @return #EINA_TRUE on success, #EINA_FALSE on failure. It is considered successful if row * had no cells filled. Failure is asking for clear row outside * matrix size. * @@ -291,7 +291,7 @@ EAPI Eina_Bool eina_matrixsparse_row_idx_clear(Eina_Matrixsparse *m, unsigned lo * @param m The sparse matrix to operate on. * @param col The new number of column to clear. * - * @return #EINA_TRUE on success, #EINA_FALSE on failure. It is considered success if column + * @return #EINA_TRUE on success, #EINA_FALSE on failure. It is considered successful if column * had no cells filled. Failure is asking for clear column outside * matrix size. * @@ -311,7 +311,7 @@ EAPI Eina_Bool eina_matrixsparse_column_idx_clear(Eina_Matrixsparse *m, unsigned * @param row The new number of row to clear. * @param col The new number of column to clear. * - * @return #EINA_TRUE on success, #EINA_FALSE on failure. It is considered success if did not + * @return #EINA_TRUE on success, #EINA_FALSE on failure. It is considered successful if did not * exist but index is inside matrix size. * * @warning Cells, rows or columns are not reference counted and thus diff --git a/src/lib/eina/eina_mmap.h b/src/lib/eina/eina_mmap.h index 8065d3ae8c..7f58f0c269 100644 --- a/src/lib/eina/eina_mmap.h +++ b/src/lib/eina/eina_mmap.h @@ -34,7 +34,7 @@ * layer, and rely on mmap to not fail for any part of the file. * * If you set up your own SIGBUS handler, then this will effectively disable - * the safe mmap handling and make you liable to crashes on IO to or from + * the safe mmap handling and make you liable to crashing on IO to or from * such "damaged files" that would take down your process. * * @since 1.1.0 diff --git a/src/lib/eina/eina_module.h b/src/lib/eina/eina_module.h index efdf0509ff..dafdb203ec 100644 --- a/src/lib/eina/eina_module.h +++ b/src/lib/eina/eina_module.h @@ -40,7 +40,7 @@ * @defgroup Eina_Module_Group Module * * Eina module provides some helpers over POSIX dlopen(). It is not - * meant to replace, abstract or make a "portable" version of the + * meant to replace, abstract or make a "portable" version of * POSIX, but enhance its usage by defining some good practices. * * Modules are created with eina_module_new() and later loaded with @@ -76,7 +76,7 @@ typedef Eina_Bool (*Eina_Module_Cb)(Eina_Module *m, void *data); /** * @typedef Eina_Module_Init - * If a function with such signature is exported by module as + * If a function with this signature is exported by module as * __eina_module_init, it will be called on the first load after * dlopen() and if #EINA_FALSE is returned, load will fail, #EINA_TRUE * means the module was successfully initialized. @@ -86,7 +86,7 @@ typedef Eina_Bool (*Eina_Module_Init)(void); /** * @typedef Eina_Module_Shutdown - * If a function with such signature is exported by module as + * If a function with this signature is exported by module as * __eina_module_shutdown, it will be called before calling dlclose() * @see Eina_Module_Init */ @@ -101,7 +101,7 @@ typedef void (*Eina_Module_Shutdown)(void); /** * @def EINA_MODULE_SHUTDOWN - * declares the given function as the module shutdownializer + * declares the given function as to be called on shutdown * (__eina_module_shutdown). It must be of signature #Eina_Module_Shutdown */ #define EINA_MODULE_SHUTDOWN(f) EXPORTAPI Eina_Module_Shutdown __eina_module_shutdown = &f @@ -148,10 +148,10 @@ EAPI Eina_Bool * * This function load the shared file object passed in * eina_module_new(). If it is a internal Eina module (like the - * mempools), it also initialize it. If the shared file object can not + * mempools), it also initializes it. If the shared file object cannot * be loaded, #EINA_FALSE is returned. If it is an internal Eina module and the - * module can not be initialized, #EINA_FALSE is returned. If the module has - * already been loaded, it's reference counter is increased by one and + * module cannot be initialized, #EINA_FALSE is returned. If the module has + * already been loaded, its reference counter is increased by one and * #EINA_TRUE is returned. If @p module is @c NULL, the function returns * immediately #EINA_FALSE. * @@ -179,13 +179,13 @@ EAPI Eina_Bool eina_module_unload(Eina_Module *module) EINA_ARG_NONNULL(1); /** - * @brief Retrieves the data associated to a symbol. + * @brief Retrieves the data associated with a symbol. * * @param module The module. * @param symbol The symbol. - * @return The data associated to the symbol, or @c NULL on failure. + * @return The data associated with the symbol, or @c NULL on failure. * - * This function returns the data associated to @p symbol of @p module. @p + * This function returns the data associated with @p symbol of @p module. @p * module must have been loaded before with eina_module_load(). If @p module * is @c NULL, or if it has not been correctly loaded before, the * function returns immediately @c NULL. @@ -194,7 +194,7 @@ EAPI void * eina_module_symbol_get(const Eina_Module *module, const char *symbol) EINA_PURE EINA_ARG_NONNULL(1, 2) EINA_WARN_UNUSED_RESULT; /** - * @brief Returns the file name associated to the module. + * @brief Returns the file name associated with the module. * * @param module The module. * @return The file name. @@ -322,13 +322,13 @@ EAPI void eina_module_list_free(Eina_Array *array) EINA_ARG_NONNULL(1); /** - * @brief Finds an module in array. + * @brief Finds a module in array. * * @param array The array to find the module. * @param module The name of module to be searched. * @return The module to find on success, @c NULL otherwise. * - * This function finds an @p module in @p array. + * This function finds a @p module in @p array. * If the element is found the function returns the module, else * @c NULL is returned. */ --
