summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBryce Harrington <bryce@osg.samsung.com>2017-11-07 08:59:02 +0000
committerAndy Williams <andy@andywilliams.me>2017-11-07 09:03:57 +0000
commit70f7f88eabf6c22e8cc1ac230a4b0851bda8c7c1 (patch)
treee7a46c910127d4b93945680ba4204067659ba049
parent3790c4d47a63fad4bee5d22d70df003aa39bab3a (diff)
eina: Fix spelling errors in documentation (matrixsparse..module)
Reviewers: cedric, ajwillia.ms Subscribers: segfaultxavi, jpeg Differential Revision: https://phab.enlightenment.org/D5425
-rw-r--r--src/lib/eina/eina_matrixsparse.h10
-rw-r--r--src/lib/eina/eina_mmap.h2
-rw-r--r--src/lib/eina/eina_module.h26
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,
96 const void *user_data); 96 const void *user_data);
97 97
98/** 98/**
99 * @brief Frees resources allocated to Sparse Matrix. 99 * @brief Frees resources allocated for Sparse Matrix.
100 * 100 *
101 * @param m The Sparse Matrix instance to free, must @b not be @c NULL. 101 * @param m The Sparse Matrix instance to free, must @b not be @c NULL.
102 */ 102 */
@@ -149,7 +149,7 @@ EAPI Eina_Bool eina_matrixsparse_size_set(Eina_Matrixsparse *m,
149 * @param col The new number of column to clear. 149 * @param col The new number of column to clear.
150 * @param cell Pointer to return cell reference, if any exists. 150 * @param cell Pointer to return cell reference, if any exists.
151 * 151 *
152 * @return @c 1 on success, @c 0 on failure. It is considered success if did not 152 * @return @c 1 on success, @c 0 on failure. It is considered successful if did not
153 * exist but index is inside matrix size, in this case @c *cell == NULL 153 * exist but index is inside matrix size, in this case @c *cell == NULL
154 * 154 *
155 * @see eina_matrixsparse_cell_data_get() 155 * @see eina_matrixsparse_cell_data_get()
@@ -272,7 +272,7 @@ EAPI Eina_Bool eina_matrixsparse_data_idx_set(Eina_Matrixsparse *m, unsigned lon
272 * @param m The sparse matrix to operate on. 272 * @param m The sparse matrix to operate on.
273 * @param row The new number of row to clear. 273 * @param row The new number of row to clear.
274 * 274 *
275 * @return #EINA_TRUE on success, #EINA_FALSE on failure. It is considered success if row 275 * @return #EINA_TRUE on success, #EINA_FALSE on failure. It is considered successful if row
276 * had no cells filled. Failure is asking for clear row outside 276 * had no cells filled. Failure is asking for clear row outside
277 * matrix size. 277 * matrix size.
278 * 278 *
@@ -291,7 +291,7 @@ EAPI Eina_Bool eina_matrixsparse_row_idx_clear(Eina_Matrixsparse *m, unsigned lo
291 * @param m The sparse matrix to operate on. 291 * @param m The sparse matrix to operate on.
292 * @param col The new number of column to clear. 292 * @param col The new number of column to clear.
293 * 293 *
294 * @return #EINA_TRUE on success, #EINA_FALSE on failure. It is considered success if column 294 * @return #EINA_TRUE on success, #EINA_FALSE on failure. It is considered successful if column
295 * had no cells filled. Failure is asking for clear column outside 295 * had no cells filled. Failure is asking for clear column outside
296 * matrix size. 296 * matrix size.
297 * 297 *
@@ -311,7 +311,7 @@ EAPI Eina_Bool eina_matrixsparse_column_idx_clear(Eina_Matrixsparse *m, unsigned
311 * @param row The new number of row to clear. 311 * @param row The new number of row to clear.
312 * @param col The new number of column to clear. 312 * @param col The new number of column to clear.
313 * 313 *
314 * @return #EINA_TRUE on success, #EINA_FALSE on failure. It is considered success if did not 314 * @return #EINA_TRUE on success, #EINA_FALSE on failure. It is considered successful if did not
315 * exist but index is inside matrix size. 315 * exist but index is inside matrix size.
316 * 316 *
317 * @warning Cells, rows or columns are not reference counted and thus 317 * @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 @@
34 * layer, and rely on mmap to not fail for any part of the file. 34 * layer, and rely on mmap to not fail for any part of the file.
35 * 35 *
36 * If you set up your own SIGBUS handler, then this will effectively disable 36 * If you set up your own SIGBUS handler, then this will effectively disable
37 * the safe mmap handling and make you liable to crashes on IO to or from 37 * the safe mmap handling and make you liable to crashing on IO to or from
38 * such "damaged files" that would take down your process. 38 * such "damaged files" that would take down your process.
39 * 39 *
40 * @since 1.1.0 40 * @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 @@
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 */