summaryrefslogtreecommitdiff
path: root/src/lib/eina
diff options
context:
space:
mode:
authorBryce Harrington <bryce@osg.samsung.com>2018-07-28 11:50:49 -0400
committerChris Michael <cp.michael@samsung.com>2018-07-28 11:50:49 -0400
commit185f2f55fd46bf8600f4fd6806a07e367adf5bdb (patch)
tree31d0d986df4fc89c0bf5cdaf7b9fb16d7bcba45d /src/lib/eina
parent06e7c859c945d6329c63e772a5d70162ce19157f (diff)
eina: Add doxygen in/out tags for mmap and module
Reviewers: devilhorns Reviewed By: devilhorns Subscribers: cedric, #committers, zmike Tags: #efl Differential Revision: https://phab.enlightenment.org/D6691
Diffstat (limited to 'src/lib/eina')
-rw-r--r--src/lib/eina/eina_mmap.h2
-rw-r--r--src/lib/eina/eina_module.h53
2 files changed, 28 insertions, 27 deletions
diff --git a/src/lib/eina/eina_mmap.h b/src/lib/eina/eina_mmap.h
index 7f58f0c269..8e7545abe1 100644
--- a/src/lib/eina/eina_mmap.h
+++ b/src/lib/eina/eina_mmap.h
@@ -15,7 +15,7 @@
15/** 15/**
16 * @brief Enables or disables safe mmaped IO handling. 16 * @brief Enables or disables safe mmaped IO handling.
17 * 17 *
18 * @param enabled The enabled state (to enable, pass #EINA_TRUE) 18 * @param[in] enabled The enabled state (to enable, pass #EINA_TRUE)
19 * @return #EINA_TRUE on success, #EINA_FALSE on failure. 19 * @return #EINA_TRUE on success, #EINA_FALSE on failure.
20 * 20 *
21 * This enables (if possible on your platform) a signal handler for 21 * This enables (if possible on your platform) a signal handler for
diff --git a/src/lib/eina/eina_module.h b/src/lib/eina/eina_module.h
index 773c29cdc9..90400546a1 100644
--- a/src/lib/eina/eina_module.h
+++ b/src/lib/eina/eina_module.h
@@ -112,7 +112,7 @@ extern EAPI Eina_Error EINA_ERROR_MODULE_INIT_FAILED;
112/** 112/**
113 * @brief Returns a new module. 113 * @brief Returns a new module.
114 * 114 *
115 * @param file The name of the file module to load. 115 * @param[in] file The name of the file module to load.
116 * @return A new module. If @p file is @c NULL, or if it does not exist, 116 * @return A new module. If @p file is @c NULL, or if it does not exist,
117 * the function returns @c NULL, otherwise, it allocates an Eina_Module, 117 * the function returns @c NULL, otherwise, it allocates an Eina_Module,
118 * stores a duplicate string of @p file, sets its reference to @c 0 and 118 * stores a duplicate string of @p file, sets its reference to @c 0 and
@@ -129,7 +129,7 @@ EAPI Eina_Module *
129/** 129/**
130 * @brief Deletes a module. 130 * @brief Deletes a module.
131 * 131 *
132 * @param module The module to delete. 132 * @param[in,out] module The module to delete.
133 * @return #EINA_TRUE on success, #EINA_FALSE otherwise. 133 * @return #EINA_TRUE on success, #EINA_FALSE otherwise.
134 * 134 *
135 * This function calls eina_module_unload() if @p module has been previously 135 * This function calls eina_module_unload() if @p module has been previously
@@ -143,7 +143,7 @@ EAPI Eina_Bool
143/** 143/**
144 * @brief Loads a module. 144 * @brief Loads a module.
145 * 145 *
146 * @param module The module to load. 146 * @param[in,out] module The module to load.
147 * @return #EINA_TRUE on success, #EINA_FALSE otherwise. 147 * @return #EINA_TRUE on success, #EINA_FALSE otherwise.
148 * 148 *
149 * This function load the shared file object passed in 149 * This function load the shared file object passed in
@@ -164,7 +164,7 @@ EAPI Eina_Bool
164/** 164/**
165 * @brief Unloads a module. 165 * @brief Unloads a module.
166 * 166 *
167 * @param module The module to load. 167 * @param[in,out] module The module to load.
168 * @return #EINA_TRUE on success, #EINA_FALSE otherwise. 168 * @return #EINA_TRUE on success, #EINA_FALSE otherwise.
169 * 169 *
170 * This function unload the module @p module that has been previously 170 * This function unload the module @p module that has been previously
@@ -181,8 +181,8 @@ EAPI Eina_Bool
181/** 181/**
182 * @brief Retrieves the data associated with a symbol. 182 * @brief Retrieves the data associated with a symbol.
183 * 183 *
184 * @param module The module. 184 * @param[in] module The module.
185 * @param symbol The symbol. 185 * @param[in] symbol The symbol.
186 * @return The data associated with 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 with @p symbol of @p module. @p 188 * This function returns the data associated with @p symbol of @p module. @p
@@ -196,7 +196,7 @@ EAPI void *
196/** 196/**
197 * @brief Returns the file name associated with the module. 197 * @brief Returns the file name associated with the module.
198 * 198 *
199 * @param module The module. 199 * @param[in] module The module.
200 * @return The file name. 200 * @return The file name.
201 * 201 *
202 * This function returns the file name passed in eina_module_new(). If 202 * This function returns the file name passed in eina_module_new(). If
@@ -209,8 +209,9 @@ EAPI const char *
209/** 209/**
210 * @brief Defines if on module load we should expose all symbol 210 * @brief Defines if on module load we should expose all symbol
211 * 211 *
212 * @param module The module to turn off/on symbol to be exposed 212 * @param[in,out] module The module to turn off/on symbol to be exposed
213 * @param global @c true to turn on symbol to be exposed, @c false otherwise 213 * @param[in] global @c true to turn on symbol to be exposed, @c false otherwise
214 *
214 * @since 1.11 215 * @since 1.11
215 */ 216 */
216EAPI void eina_module_symbol_global_set(Eina_Module *module, Eina_Bool global) EINA_ARG_NONNULL(1); 217EAPI void eina_module_symbol_global_set(Eina_Module *module, Eina_Bool global) EINA_ARG_NONNULL(1);
@@ -219,8 +220,8 @@ EAPI void eina_module_symbol_global_set(Eina_Module *module, Eina_Bool global) E
219 * @brief Returns the path built from the location of a library and a 220 * @brief Returns the path built from the location of a library and a
220 * given sub directory. 221 * given sub directory.
221 * 222 *
222 * @param symbol The symbol to search for. 223 * @param[in] symbol The symbol to search for.
223 * @param sub_dir The subdirectory to append. 224 * @param[in] sub_dir The subdirectory to append.
224 * @return The built path on success, @c NULL otherwise. 225 * @return The built path on success, @c NULL otherwise.
225 * 226 *
226 * This function returns the path built by concatenating the path of 227 * This function returns the path built by concatenating the path of
@@ -236,8 +237,8 @@ EAPI char *
236 * @brief Returns the path built from the value of an environment variable and a 237 * @brief Returns the path built from the value of an environment variable and a
237 * given sub directory. 238 * given sub directory.
238 * 239 *
239 * @param env The environment variable to expand. 240 * @param[in] env The environment variable to expand.
240 * @param sub_dir The subdirectory to append. 241 * @param[in] sub_dir The subdirectory to append.
241 * @return The built path on success, @c NULL otherwise. 242 * @return The built path on success, @c NULL otherwise.
242 * 243 *
243 * This function returns the path built by concatenating the value of 244 * This function returns the path built by concatenating the value of
@@ -253,9 +254,9 @@ EAPI char *
253/** 254/**
254 * @brief Gets an array of modules found on the directory path matching an arch type. 255 * @brief Gets an array of modules found on the directory path matching an arch type.
255 * 256 *
256 * @param array The array that stores the list of the modules. 257 * @param[in,out] array The array that stores the list of the modules.
257 * @param path The directory's path to search for modules. 258 * @param[in] path The directory's path to search for modules.
258 * @param arch The architecture string. 259 * @param[in] arch The architecture string.
259 * @return The array of modules found in @p path matching @p arch. 260 * @return The array of modules found in @p path matching @p arch.
260 * 261 *
261 * This function adds to @p array the module names found in @p path 262 * This function adds to @p array the module names found in @p path
@@ -269,11 +270,11 @@ EAPI Eina_Array *
269/** 270/**
270 * @brief Gets a list of modules found on the directory path. 271 * @brief Gets a list of modules found on the directory path.
271 * 272 *
272 * @param array The array that stores the list of the modules. 273 * @param[in,out] array The array that stores the list of the modules.
273 * @param path The directory's path to search for modules. 274 * @param[in] path The directory's path to search for modules.
274 * @param recursive Iterate recursively on the path. 275 * @param[in] recursive Iterate recursively on the path.
275 * @param cb Callback function to call on each module. 276 * @param[in] cb Callback function to call on each module.
276 * @param data Data passed to the callback function. 277 * @param[in] data Data passed to the callback function.
277 * @return The array of modules found in @p path. 278 * @return The array of modules found in @p path.
278 * 279 *
279 * This function adds to @p array the list of modules found in 280 * This function adds to @p array the list of modules found in
@@ -291,7 +292,7 @@ EAPI Eina_Array *
291/** 292/**
292 * @brief Loads every module on the list of modules. 293 * @brief Loads every module on the list of modules.
293 * 294 *
294 * @param array The array of modules to load. 295 * @param[in,out] array The array of modules to load.
295 * 296 *
296 * This function calls eina_module_load() on each element found in 297 * This function calls eina_module_load() on each element found in
297 * @p array. If @p array is @c NULL, this function does nothing. 298 * @p array. If @p array is @c NULL, this function does nothing.
@@ -302,7 +303,7 @@ EAPI void
302/** 303/**
303 * @brief Unloads every module on the list of modules. 304 * @brief Unloads every module on the list of modules.
304 * 305 *
305 * @param array The array of modules to unload. 306 * @param[in,out] array The array of modules to unload.
306 * 307 *
307 * This function calls eina_module_unload() on each element found in 308 * This function calls eina_module_unload() on each element found in
308 * @p array. If @p array is @c NULL, this function does nothing. 309 * @p array. If @p array is @c NULL, this function does nothing.
@@ -313,7 +314,7 @@ EAPI void
313/** 314/**
314 * @p Frees every module on the list of modules. 315 * @p Frees every module on the list of modules.
315 * 316 *
316 * @param array The array of modules to free. 317 * @param[in,out] array The array of modules to free.
317 * 318 *
318 * This function calls eina_module_free() on each element found in 319 * This function calls eina_module_free() on each element found in
319 * @p array. If @p array is @c NULL, this function does nothing. 320 * @p array. If @p array is @c NULL, this function does nothing.
@@ -324,8 +325,8 @@ EAPI void
324/** 325/**
325 * @brief Finds a module in array. 326 * @brief Finds a module in array.
326 * 327 *
327 * @param array The array to find the module. 328 * @param[in] array The array to find the module.
328 * @param module The name of module to be searched. 329 * @param[in] module The name of module to be searched.
329 * @return The module to find on success, @c NULL otherwise. 330 * @return The module to find on success, @c NULL otherwise.
330 * 331 *
331 * This function finds a @p module in @p array. 332 * This function finds a @p module in @p array.