diff options
author | Bryce Harrington <bryce@osg.samsung.com> | 2017-11-07 08:59:02 +0000 |
---|---|---|
committer | Andy Williams <andy@andywilliams.me> | 2017-11-07 09:03:57 +0000 |
commit | 70f7f88eabf6c22e8cc1ac230a4b0851bda8c7c1 (patch) | |
tree | e7a46c910127d4b93945680ba4204067659ba049 /src/lib/eina/eina_module.h | |
parent | 3790c4d47a63fad4bee5d22d70df003aa39bab3a (diff) |
eina: Fix spelling errors in documentation (matrixsparse..module)
Reviewers: cedric, ajwillia.ms
Subscribers: segfaultxavi, jpeg
Differential Revision: https://phab.enlightenment.org/D5425
Diffstat (limited to '')
-rw-r--r-- | src/lib/eina/eina_module.h | 26 |
1 files changed, 13 insertions, 13 deletions
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 @@ | |||
40 | * @defgroup Eina_Module_Group Module | 40 | * @defgroup Eina_Module_Group Module |
41 | * | 41 | * |
42 | * Eina module provides some helpers over POSIX dlopen(). It is not | 42 | * Eina module provides some helpers over POSIX dlopen(). It is not |
43 | * meant to replace, abstract or make a "portable" version of the | 43 | * meant to replace, abstract or make a "portable" version of |
44 | * POSIX, but enhance its usage by defining some good practices. | 44 | * POSIX, but enhance its usage by defining some good practices. |
45 | * | 45 | * |
46 | * Modules are created with eina_module_new() and later loaded with | 46 | * 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); | |||
76 | 76 | ||
77 | /** | 77 | /** |
78 | * @typedef Eina_Module_Init | 78 | * @typedef Eina_Module_Init |
79 | * If a function with such signature is exported by module as | 79 | * If a function with this signature is exported by module as |
80 | * __eina_module_init, it will be called on the first load after | 80 | * __eina_module_init, it will be called on the first load after |
81 | * dlopen() and if #EINA_FALSE is returned, load will fail, #EINA_TRUE | 81 | * dlopen() and if #EINA_FALSE is returned, load will fail, #EINA_TRUE |
82 | * means the module was successfully initialized. | 82 | * means the module was successfully initialized. |
@@ -86,7 +86,7 @@ typedef Eina_Bool (*Eina_Module_Init)(void); | |||
86 | 86 | ||
87 | /** | 87 | /** |
88 | * @typedef Eina_Module_Shutdown | 88 | * @typedef Eina_Module_Shutdown |
89 | * If a function with such signature is exported by module as | 89 | * If a function with this signature is exported by module as |
90 | * __eina_module_shutdown, it will be called before calling dlclose() | 90 | * __eina_module_shutdown, it will be called before calling dlclose() |
91 | * @see Eina_Module_Init | 91 | * @see Eina_Module_Init |
92 | */ | 92 | */ |
@@ -101,7 +101,7 @@ typedef void (*Eina_Module_Shutdown)(void); | |||
101 | 101 | ||
102 | /** | 102 | /** |
103 | * @def EINA_MODULE_SHUTDOWN | 103 | * @def EINA_MODULE_SHUTDOWN |
104 | * declares the given function as the module shutdownializer | 104 | * declares the given function as to be called on shutdown |
105 | * (__eina_module_shutdown). It must be of signature #Eina_Module_Shutdown | 105 | * (__eina_module_shutdown). It must be of signature #Eina_Module_Shutdown |
106 | */ | 106 | */ |
107 | #define EINA_MODULE_SHUTDOWN(f) EXPORTAPI Eina_Module_Shutdown __eina_module_shutdown = &f | 107 | #define EINA_MODULE_SHUTDOWN(f) EXPORTAPI Eina_Module_Shutdown __eina_module_shutdown = &f |
@@ -148,10 +148,10 @@ EAPI Eina_Bool | |||
148 | * | 148 | * |
149 | * This function load the shared file object passed in | 149 | * This function load the shared file object passed in |
150 | * eina_module_new(). If it is a internal Eina module (like the | 150 | * eina_module_new(). If it is a internal Eina module (like the |
151 | * mempools), it also initialize it. If the shared file object can not | 151 | * mempools), it also initializes it. If the shared file object cannot |
152 | * be loaded, #EINA_FALSE is returned. If it is an internal Eina module and the | 152 | * be loaded, #EINA_FALSE is returned. If it is an internal Eina module and the |
153 | * module can not be initialized, #EINA_FALSE is returned. If the module has | 153 | * module cannot be initialized, #EINA_FALSE is returned. If the module has |
154 | * already been loaded, it's reference counter is increased by one and | 154 | * already been loaded, its reference counter is increased by one and |
155 | * #EINA_TRUE is returned. If @p module is @c NULL, the function returns | 155 | * #EINA_TRUE is returned. If @p module is @c NULL, the function returns |
156 | * immediately #EINA_FALSE. | 156 | * immediately #EINA_FALSE. |
157 | * | 157 | * |
@@ -179,13 +179,13 @@ EAPI Eina_Bool | |||
179 | eina_module_unload(Eina_Module *module) EINA_ARG_NONNULL(1); | 179 | eina_module_unload(Eina_Module *module) EINA_ARG_NONNULL(1); |
180 | 180 | ||
181 | /** | 181 | /** |
182 | * @brief Retrieves the data associated to a symbol. | 182 | * @brief Retrieves the data associated with a symbol. |
183 | * | 183 | * |
184 | * @param module The module. | 184 | * @param module The module. |
185 | * @param symbol The symbol. | 185 | * @param symbol The symbol. |
186 | * @return The data associated to the symbol, or @c NULL on failure. | 186 | * @return The data associated with the symbol, or @c NULL on failure. |
187 | * | 187 | * |
188 | * This function returns the data associated to @p symbol of @p module. @p | 188 | * This function returns the data associated with @p symbol of @p module. @p |
189 | * module must have been loaded before with eina_module_load(). If @p module | 189 | * module must have been loaded before with eina_module_load(). If @p module |
190 | * is @c NULL, or if it has not been correctly loaded before, the | 190 | * is @c NULL, or if it has not been correctly loaded before, the |
191 | * function returns immediately @c NULL. | 191 | * function returns immediately @c NULL. |
@@ -194,7 +194,7 @@ EAPI void * | |||
194 | eina_module_symbol_get(const Eina_Module *module, const char *symbol) EINA_PURE EINA_ARG_NONNULL(1, 2) EINA_WARN_UNUSED_RESULT; | 194 | eina_module_symbol_get(const Eina_Module *module, const char *symbol) EINA_PURE EINA_ARG_NONNULL(1, 2) EINA_WARN_UNUSED_RESULT; |
195 | 195 | ||
196 | /** | 196 | /** |
197 | * @brief Returns the file name associated to the module. | 197 | * @brief Returns the file name associated with the module. |
198 | * | 198 | * |
199 | * @param module The module. | 199 | * @param module The module. |
200 | * @return The file name. | 200 | * @return The file name. |
@@ -322,13 +322,13 @@ EAPI void | |||
322 | eina_module_list_free(Eina_Array *array) EINA_ARG_NONNULL(1); | 322 | eina_module_list_free(Eina_Array *array) EINA_ARG_NONNULL(1); |
323 | 323 | ||
324 | /** | 324 | /** |
325 | * @brief Finds an module in array. | 325 | * @brief Finds a module in array. |
326 | * | 326 | * |
327 | * @param array The array to find the module. | 327 | * @param array The array to find the module. |
328 | * @param module The name of module to be searched. | 328 | * @param module The name of module to be searched. |
329 | * @return The module to find on success, @c NULL otherwise. | 329 | * @return The module to find on success, @c NULL otherwise. |
330 | * | 330 | * |
331 | * This function finds an @p module in @p array. | 331 | * This function finds a @p module in @p array. |
332 | * If the element is found the function returns the module, else | 332 | * If the element is found the function returns the module, else |
333 | * @c NULL is returned. | 333 | * @c NULL is returned. |
334 | */ | 334 | */ |