summaryrefslogtreecommitdiff
path: root/src/lib/ecore_file
diff options
context:
space:
mode:
authorMyoungwoon Roy, Kim <myoungwoon.kim@samsung.com>2017-02-27 19:35:52 +0900
committerJean-Philippe Andre <jp.andre@samsung.com>2017-02-27 19:37:43 +0900
commit8c19d9251d2d243922057363b738780d770b4de5 (patch)
tree70467aa795a5b07c22d386cb0e4010cb22c0cfa8 /src/lib/ecore_file
parent726994d175fb758b0b904418dbce13efd7f0cef6 (diff)
docs: Fix typos and some wrong expressions
Covers: Ecore_Drm, Ecore_Evas, Ecore_File, Ecore_IMF, and Ecore_IMF_Evas API reference doxygen. Summary: I had fixed some typos and wrong expressions, such as capital letters, singular Etc. in Ecore_Drm, Ecore_Evas, Ecore_File, Ecore_IMF, and Ecore_IMF_Evas API reference doxygen. Test Plan: Doxygen Revision Reviewers: stefan, cedric, raster, jpeg, Jaehyun_Cho Subscribers: conr2d Differential Revision: https://phab.enlightenment.org/D4680
Diffstat (limited to 'src/lib/ecore_file')
-rw-r--r--src/lib/ecore_file/Ecore_File.h108
1 files changed, 54 insertions, 54 deletions
diff --git a/src/lib/ecore_file/Ecore_File.h b/src/lib/ecore_file/Ecore_File.h
index 4e8810b1de..9a8402df31 100644
--- a/src/lib/ecore_file/Ecore_File.h
+++ b/src/lib/ecore_file/Ecore_File.h
@@ -36,7 +36,7 @@
36 36
37/** 37/**
38 * @file Ecore_File.h 38 * @file Ecore_File.h
39 * @brief Files utility functions 39 * @brief Files utility functions.
40 */ 40 */
41 41
42#ifdef __cplusplus 42#ifdef __cplusplus
@@ -115,9 +115,9 @@ typedef int (*Ecore_File_Download_Progress_Cb)(void *data,
115/* File operations */ 115/* File operations */
116 116
117/** 117/**
118 * @brief Initialize the Ecore_File library. 118 * @brief Initializes the Ecore_File library.
119 * 119 *
120 * @return 1 or greater on success, 0 on error. 120 * @return @c 1 or greater on success, otherwise @c 0 on error.
121 * 121 *
122 * This function sets up Ecore_File and the services it will use 122 * This function sets up Ecore_File and the services it will use
123 * (monitoring, downloading, PATH related feature). It returns 0 on 123 * (monitoring, downloading, PATH related feature). It returns 0 on
@@ -130,9 +130,9 @@ typedef int (*Ecore_File_Download_Progress_Cb)(void *data,
130EAPI int ecore_file_init (void); 130EAPI int ecore_file_init (void);
131 131
132/** 132/**
133 * @brief Shut down the Ecore_File library. 133 * @brief Shuts down the Ecore_File library.
134 * 134 *
135 * @return 0 when the library is completely shut down, 1 or 135 * @return @c 0 when the library is completely shut down, @c 1 or
136 * greater otherwise. 136 * greater otherwise.
137 * 137 *
138 * This function shuts down the Ecore_File library. It returns 0 when it has 138 * This function shuts down the Ecore_File library. It returns 0 when it has
@@ -142,10 +142,10 @@ EAPI int ecore_file_init (void);
142EAPI int ecore_file_shutdown (void); 142EAPI int ecore_file_shutdown (void);
143 143
144/** 144/**
145 * @brief Get the time of the last modification to the given file. 145 * @brief Gets the time of the last modification to the given file.
146 * 146 *
147 * @param file The name of the file. 147 * @param file The name of the file.
148 * @return Return the time of the last data modification, or 0 on 148 * @return Return the time of the last data modification, or @c 0 on
149 * failure. 149 * failure.
150 * 150 *
151 * This function returns the time of the last modification of 151 * This function returns the time of the last modification of
@@ -154,10 +154,10 @@ EAPI int ecore_file_shutdown (void);
154EAPI long long ecore_file_mod_time (const char *file); 154EAPI long long ecore_file_mod_time (const char *file);
155 155
156/** 156/**
157 * @brief Get the size of the given file. 157 * @brief Gets the size of the given file.
158 * 158 *
159 * @param file The name of the file. 159 * @param file The name of the file.
160 * @return Return the size of the file in bytes, or 0 on failure. 160 * @return Return the size of the file in bytes, or @c 0 on failure.
161 * 161 *
162 * This function returns the size of @p file in bytes. On failure, it 162 * This function returns the size of @p file in bytes. On failure, it
163 * returns 0. 163 * returns 0.
@@ -165,7 +165,7 @@ EAPI long long ecore_file_mod_time (const char *file);
165EAPI long long ecore_file_size (const char *file); 165EAPI long long ecore_file_size (const char *file);
166 166
167/** 167/**
168 * @brief Check if the given file exists. 168 * @brief Checks if the given file exists.
169 * 169 *
170 * @param file The name of the file. 170 * @param file The name of the file.
171 * @return @c EINA_TRUE if the @p file exists, @c EINA_FALSE otherwise. 171 * @return @c EINA_TRUE if the @p file exists, @c EINA_FALSE otherwise.
@@ -176,7 +176,7 @@ EAPI long long ecore_file_size (const char *file);
176EAPI Eina_Bool ecore_file_exists (const char *file); 176EAPI Eina_Bool ecore_file_exists (const char *file);
177 177
178/** 178/**
179 * @brief Check if the given file is a directory. 179 * @brief Checks if the given file is a directory.
180 * 180 *
181 * @param file The name of the file. 181 * @param file The name of the file.
182 * @return @c EINA_TRUE if the file exists and is a directory, @c EINA_FALSE 182 * @return @c EINA_TRUE if the file exists and is a directory, @c EINA_FALSE
@@ -188,7 +188,7 @@ EAPI Eina_Bool ecore_file_exists (const char *file);
188EAPI Eina_Bool ecore_file_is_dir (const char *file); 188EAPI Eina_Bool ecore_file_is_dir (const char *file);
189 189
190/** 190/**
191 * @brief Create a new directory. 191 * @brief Creates a new directory.
192 * 192 *
193 * @param dir The name of the directory to create 193 * @param dir The name of the directory to create
194 * @return @c EINA_TRUE on successful creation, @c EINA_FALSE otherwise. 194 * @return @c EINA_TRUE on successful creation, @c EINA_FALSE otherwise.
@@ -201,7 +201,7 @@ EAPI Eina_Bool ecore_file_is_dir (const char *file);
201EAPI Eina_Bool ecore_file_mkdir (const char *dir); 201EAPI Eina_Bool ecore_file_mkdir (const char *dir);
202 202
203/** 203/**
204 * @brief Create complete directory in a batch. 204 * @brief Creates complete directory in a batch.
205 * 205 *
206 * @param dirs The list of directories, null terminated. 206 * @param dirs The list of directories, null terminated.
207 * @return The number of successful directories created, -1 if dirs is 207 * @return The number of successful directories created, -1 if dirs is
@@ -210,17 +210,17 @@ EAPI Eina_Bool ecore_file_mkdir (const char *dir);
210 * This function creates all the directories that are in the null 210 * This function creates all the directories that are in the null
211 * terminated array @p dirs. The function loops over the directories 211 * terminated array @p dirs. The function loops over the directories
212 * and call ecore_file_mkdir(). This function returns -1 if @p dirs is 212 * and call ecore_file_mkdir(). This function returns -1 if @p dirs is
213 * @c NULL, otherwise if returns the number of suceesfully created 213 * @c NULL, otherwise if returns the number of successfully created
214 * directories. 214 * directories.
215 */ 215 */
216EAPI int ecore_file_mkdirs (const char **dirs); 216EAPI int ecore_file_mkdirs (const char **dirs);
217 217
218/** 218/**
219 * @brief Create complete list of sub-directories in a batch (optimized). 219 * @brief Creates complete list of sub-directories in a batch (optimized).
220 * 220 *
221 * @param base The base directory to act on. 221 * @param base The base directory to act on.
222 * @param subdirs The list of directories, null terminated. 222 * @param subdirs The list of directories, null terminated.
223 * @return number of successful directories created, -1 on failure. 223 * @return The number of successful directories created, @c -1 on failure.
224 * 224 *
225 * This function creates all the directories that are in the null 225 * This function creates all the directories that are in the null
226 * terminated array @p subdirs in the @p base directory. If @p base does 226 * terminated array @p subdirs in the @p base directory. If @p base does
@@ -231,12 +231,12 @@ EAPI int ecore_file_mkdirs (const char **dirs);
231 * returns -1 if @p subdirs or @p base are @c NULL, or if @p base is 231 * returns -1 if @p subdirs or @p base are @c NULL, or if @p base is
232 * empty ("\0"). It returns 0 is @p base is not a directory or 232 * empty ("\0"). It returns 0 is @p base is not a directory or
233 * invalid, or if it can't be created. Otherwise if returns the number 233 * invalid, or if it can't be created. Otherwise if returns the number
234 * of suceesfully created directories. 234 * of successfully created directories.
235 */ 235 */
236EAPI int ecore_file_mksubdirs (const char *base, const char **subdirs); 236EAPI int ecore_file_mksubdirs (const char *base, const char **subdirs);
237 237
238/** 238/**
239 * @brief Delete the given empty directory. 239 * @brief Deletes the given empty directory.
240 * 240 *
241 * @param dir The name of the directory to delete. 241 * @param dir The name of the directory to delete.
242 * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise. 242 * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise.
@@ -247,7 +247,7 @@ EAPI int ecore_file_mksubdirs (const char *base, const char **subd
247EAPI Eina_Bool ecore_file_rmdir (const char *dir); 247EAPI Eina_Bool ecore_file_rmdir (const char *dir);
248 248
249/** 249/**
250 * @brief Delete the given directory and all its contents. 250 * @brief Deletes the given directory and all its contents.
251 * 251 *
252 * @param dir The name of the directory to delete. 252 * @param dir The name of the directory to delete.
253 * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise. 253 * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise.
@@ -259,9 +259,9 @@ EAPI Eina_Bool ecore_file_rmdir (const char *dir);
259EAPI Eina_Bool ecore_file_recursive_rm (const char *dir); 259EAPI Eina_Bool ecore_file_recursive_rm (const char *dir);
260 260
261/** 261/**
262 * @brief Create a complete path. 262 * @brief Creates a complete path.
263 * 263 *
264 * @param path The path to create 264 * @param path The path to create
265 * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise. 265 * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise.
266 * 266 *
267 * This function creates @p path and all the subdirectories it 267 * This function creates @p path and all the subdirectories it
@@ -272,22 +272,22 @@ EAPI Eina_Bool ecore_file_recursive_rm (const char *dir);
272EAPI Eina_Bool ecore_file_mkpath (const char *path); 272EAPI Eina_Bool ecore_file_mkpath (const char *path);
273 273
274/** 274/**
275 * @brief Create complete paths in a batch. 275 * @brief Creates complete paths in a batch.
276 * 276 *
277 * @param paths list of paths, null terminated. 277 * @param paths list of paths, null terminated.
278 * @return number of successful paths created, -1 if paths is NULL. 278 * @return The number of successful paths created, @c -1 if paths is NULL.
279 * 279 *
280 * This function creates all the directories that are in the null 280 * This function creates all the directories that are in the null
281 * terminated array @p paths. The function loops over the directories 281 * terminated array @p paths. The function loops over the directories
282 * and call ecore_file_mkpath(), hence on Windows, '\' must be 282 * and call ecore_file_mkpath(), hence on Windows, '\' must be
283 * replaced by '/' before calling that function. This function 283 * replaced by '/' before calling that function. This function
284 * returns -1 if @p paths is @c NULL. Otherwise if returns the number 284 * returns -1 if @p paths is @c NULL. Otherwise if returns the number
285 * of suceesfully created directories. 285 * of successfully created directories.
286 */ 286 */
287EAPI int ecore_file_mkpaths (const char **paths); 287EAPI int ecore_file_mkpaths (const char **paths);
288 288
289/** 289/**
290 * @brief Copy the given file to the given destination. 290 * @brief Copies the given file to the given destination.
291 * 291 *
292 * @param src The name of the source file. 292 * @param src The name of the source file.
293 * @param dst The name of the destination file. 293 * @param dst The name of the destination file.
@@ -301,7 +301,7 @@ EAPI int ecore_file_mkpaths (const char **paths);
301EAPI Eina_Bool ecore_file_cp (const char *src, const char *dst); 301EAPI Eina_Bool ecore_file_cp (const char *src, const char *dst);
302 302
303/** 303/**
304 * @brief Move the given file to the given destination. 304 * @brief Moves the given file to the given destination.
305 * 305 *
306 * @param src The name of the source file. 306 * @param src The name of the source file.
307 * @param dst The name of the destination file. 307 * @param dst The name of the destination file.
@@ -313,7 +313,7 @@ EAPI Eina_Bool ecore_file_cp (const char *src, const char *dst);
313EAPI Eina_Bool ecore_file_mv (const char *src, const char *dst); 313EAPI Eina_Bool ecore_file_mv (const char *src, const char *dst);
314 314
315/** 315/**
316 * @brief Create a symbolic link. 316 * @brief Creates a symbolic link.
317 * 317 *
318 * @param src The name of the file to link. 318 * @param src The name of the file to link.
319 * @param dest The name of link. 319 * @param dest The name of link.
@@ -326,7 +326,7 @@ EAPI Eina_Bool ecore_file_mv (const char *src, const char *dst);
326EAPI Eina_Bool ecore_file_symlink (const char *src, const char *dest); 326EAPI Eina_Bool ecore_file_symlink (const char *src, const char *dest);
327 327
328/** 328/**
329 * @brief Get the canonicalized absolute path name. 329 * @brief Gets the canonicalized absolute path name.
330 * 330 *
331 * @param file The file path. 331 * @param file The file path.
332 * @return The canonicalized absolute pathname or an empty string on 332 * @return The canonicalized absolute pathname or an empty string on
@@ -340,7 +340,7 @@ EAPI Eina_Bool ecore_file_symlink (const char *src, const char *dest);
340EAPI char *ecore_file_realpath (const char *file); 340EAPI char *ecore_file_realpath (const char *file);
341 341
342/** 342/**
343 * @brief Delete the given file. 343 * @brief Deletes the given file.
344 * 344 *
345 * @param file The name of the file to delete. 345 * @param file The name of the file to delete.
346 * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise. 346 * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise.
@@ -351,7 +351,7 @@ EAPI char *ecore_file_realpath (const char *file);
351EAPI Eina_Bool ecore_file_unlink (const char *file); 351EAPI Eina_Bool ecore_file_unlink (const char *file);
352 352
353/** 353/**
354 * @brief Remove the given file or directory. 354 * @brief Removes the given file or directory.
355 * 355 *
356 * @param file The name of the file or directory to delete. 356 * @param file The name of the file or directory to delete.
357 * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise. 357 * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise.
@@ -362,7 +362,7 @@ EAPI Eina_Bool ecore_file_unlink (const char *file);
362EAPI Eina_Bool ecore_file_remove (const char *file); 362EAPI Eina_Bool ecore_file_remove (const char *file);
363 363
364/** 364/**
365 * Get the filename from a given path. 365 * @brief Gets the filename from a given path.
366 * 366 *
367 * @param path The complete path. 367 * @param path The complete path.
368 * @return The file name. 368 * @return The file name.
@@ -373,7 +373,7 @@ EAPI Eina_Bool ecore_file_remove (const char *file);
373EAPI const char *ecore_file_file_get (const char *path); 373EAPI const char *ecore_file_file_get (const char *path);
374 374
375/** 375/**
376 * @brief Get the directory where the given file resides. 376 * @brief Gets the directory where the given file resides.
377 * 377 *
378 * @param file The name of the file. 378 * @param file The name of the file.
379 * @return The directory name. 379 * @return The directory name.
@@ -386,7 +386,7 @@ EAPI const char *ecore_file_file_get (const char *path);
386EAPI char *ecore_file_dir_get (const char *path); 386EAPI char *ecore_file_dir_get (const char *path);
387 387
388/** 388/**
389 * @brief Check if the given file can be read. 389 * @brief Checks if the given file can be read.
390 * 390 *
391 * @param file The name of the file. 391 * @param file The name of the file.
392 * @return @c EINA_TRUE if the @p file is readable, @c EINA_FALSE otherwise. 392 * @return @c EINA_TRUE if the @p file is readable, @c EINA_FALSE otherwise.
@@ -397,7 +397,7 @@ EAPI char *ecore_file_dir_get (const char *path);
397EAPI Eina_Bool ecore_file_can_read (const char *file); 397EAPI Eina_Bool ecore_file_can_read (const char *file);
398 398
399/** 399/**
400 * @brief Check if the given file can be written. 400 * @brief Checks if the given file can be written.
401 * 401 *
402 * @param file The name of the file. 402 * @param file The name of the file.
403 * @return @c EINA_TRUE if the @p file is writable, @c EINA_FALSE otherwise. 403 * @return @c EINA_TRUE if the @p file is writable, @c EINA_FALSE otherwise.
@@ -408,7 +408,7 @@ EAPI Eina_Bool ecore_file_can_read (const char *file);
408EAPI Eina_Bool ecore_file_can_write (const char *file); 408EAPI Eina_Bool ecore_file_can_write (const char *file);
409 409
410/** 410/**
411 * @brief Check if the given file can be executed. 411 * @brief Checks if the given file can be executed.
412 * 412 *
413 * @param file The name of the file. 413 * @param file The name of the file.
414 * @return @c EINA_TRUE if the @p file can be executed, @c EINA_FALSE 414 * @return @c EINA_TRUE if the @p file can be executed, @c EINA_FALSE
@@ -420,7 +420,7 @@ EAPI Eina_Bool ecore_file_can_write (const char *file);
420EAPI Eina_Bool ecore_file_can_exec (const char *file); 420EAPI Eina_Bool ecore_file_can_exec (const char *file);
421 421
422/** 422/**
423 * @brief Get the path pointed by the given link. 423 * @brief Gets the path pointed by the given link.
424 * 424 *
425 * @param lnk The name of the link. 425 * @param lnk The name of the link.
426 * @return The path pointed by link or NULL. 426 * @return The path pointed by link or NULL.
@@ -433,7 +433,7 @@ EAPI Eina_Bool ecore_file_can_exec (const char *file);
433EAPI char *ecore_file_readlink (const char *link); 433EAPI char *ecore_file_readlink (const char *link);
434 434
435/** 435/**
436 * @brief Get the list of the files and directories in the given 436 * @brief Gets the list of the files and directories in the given
437 * directory. 437 * directory.
438 * 438 *
439 * @param dir The name of the directory to list 439 * @param dir The name of the directory to list
@@ -452,7 +452,7 @@ EAPI char *ecore_file_readlink (const char *link);
452EAPI Eina_List *ecore_file_ls (const char *dir); 452EAPI Eina_List *ecore_file_ls (const char *dir);
453 453
454/** 454/**
455 * @brief Return the executable from the given command. 455 * @brief Returns the executable from the given command.
456 * 456 *
457 * @param app The application command, with parameters. 457 * @param app The application command, with parameters.
458 * @return The executable from @p app as a newly allocated string. Arguments 458 * @return The executable from @p app as a newly allocated string. Arguments
@@ -463,7 +463,7 @@ EAPI Eina_List *ecore_file_ls (const char *dir);
463EAPI char *ecore_file_app_exe_get (const char *app); 463EAPI char *ecore_file_app_exe_get (const char *app);
464 464
465/** 465/**
466 * @brief Add the escape sequence ('\\') to the given file name. 466 * @brief Adds the escape sequence ('\\') to the given file name.
467 * 467 *
468 * @param filename The file name. 468 * @param filename The file name.
469 * @return The file name with special characters escaped. 469 * @return The file name with special characters escaped.
@@ -477,10 +477,10 @@ EAPI char *ecore_file_app_exe_get (const char *app);
477EAPI char *ecore_file_escape_name (const char *filename); 477EAPI char *ecore_file_escape_name (const char *filename);
478 478
479/** 479/**
480 * @brief Remove the extension from the given file name. 480 * @brief Removes the extension from the given file name.
481 * 481 *
482 * @param path The name of the file. 482 * @param path The name of the file.
483 * @return A newly allocated string with the extension stripped out or 483 * @return A newly allocated string with the extension stripped out, or
484 * @c NULL on errors. 484 * @c NULL on errors.
485 * 485 *
486 * This function removes the extension from @p path and returns the 486 * This function removes the extension from @p path and returns the
@@ -491,10 +491,10 @@ EAPI char *ecore_file_escape_name (const char *filename);
491EAPI char *ecore_file_strip_ext (const char *file); 491EAPI char *ecore_file_strip_ext (const char *file);
492 492
493/** 493/**
494 * @brief Check if the given directory is empty. 494 * @brief Checks if the given directory is empty.
495 * 495 *
496 * @param dir The name of the directory to check. 496 * @param dir The name of the directory to check.
497 * @return @c 1 if directory is empty, @c 0 if it has at least one file or 497 * @return @c 1 if directory is empty, @c 0 if it has at least one file, or
498 * @c -1 in case of errors. 498 * @c -1 in case of errors.
499 * 499 *
500 * This functions checks if @p dir is empty. The '.' and '..' files 500 * This functions checks if @p dir is empty. The '.' and '..' files
@@ -506,7 +506,7 @@ EAPI int ecore_file_dir_is_empty (const char *dir);
506/* Monitoring */ 506/* Monitoring */
507 507
508/** 508/**
509 * @brief Monitor the given path using inotify, Windows notification, or polling. 509 * @brief Monitors the given path using inotify, Windows notification, or polling.
510 * 510 *
511 * @param path The path to monitor. 511 * @param path The path to monitor.
512 * @param func The function to call on changes. 512 * @param func The function to call on changes.
@@ -527,7 +527,7 @@ EAPI Ecore_File_Monitor *ecore_file_monitor_add(const char *path,
527 void *data); 527 void *data);
528 528
529/** 529/**
530 * @brief Stop the monitoring of the given path. 530 * @brief Stops the monitoring of the given path.
531 * 531 *
532 * @param em The Ecore_File_Monitor to stop. 532 * @param em The Ecore_File_Monitor to stop.
533 * 533 *
@@ -540,7 +540,7 @@ EAPI Ecore_File_Monitor *ecore_file_monitor_add(const char *path,
540EAPI void ecore_file_monitor_del(Ecore_File_Monitor *ecore_file_monitor); 540EAPI void ecore_file_monitor_del(Ecore_File_Monitor *ecore_file_monitor);
541 541
542/** 542/**
543 * @brief Get the monitored path. 543 * @brief Gets the monitored path.
544 * 544 *
545 * @param em The Ecore_File_Monitor to query. 545 * @param em The Ecore_File_Monitor to query.
546 * @return The path that is monitored by @p em. 546 * @return The path that is monitored by @p em.
@@ -555,7 +555,7 @@ EAPI const char *ecore_file_monitor_path_get(Ecore_File_Monitor *ecore_f
555/* Path */ 555/* Path */
556 556
557/** 557/**
558 * @brief Check if the given directory is in PATH. 558 * @brief Checks if the given directory is in PATH.
559 * 559 *
560 * @param in_dir The name of the directory to search in PATH. 560 * @param in_dir The name of the directory to search in PATH.
561 * @return @c EINA_TRUE if the directory exist in PATH, @c EINA_FALSE otherwise. 561 * @return @c EINA_TRUE if the directory exist in PATH, @c EINA_FALSE otherwise.
@@ -568,7 +568,7 @@ EAPI const char *ecore_file_monitor_path_get(Ecore_File_Monitor *ecore_f
568EAPI Eina_Bool ecore_file_path_dir_exists(const char *in_dir); 568EAPI Eina_Bool ecore_file_path_dir_exists(const char *in_dir);
569 569
570/** 570/**
571 * @brief Check if the given application is installed. 571 * @brief Checks if the given application is installed.
572 * 572 *
573 * @param exe The name of the application 573 * @param exe The name of the application
574 * @return @c EINA_TRUE if the @p exe is in PATH and is executable, 574 * @return @c EINA_TRUE if the @p exe is in PATH and is executable,
@@ -581,7 +581,7 @@ EAPI Eina_Bool ecore_file_path_dir_exists(const char *in_dir);
581EAPI Eina_Bool ecore_file_app_installed(const char *exe); 581EAPI Eina_Bool ecore_file_app_installed(const char *exe);
582 582
583/** 583/**
584 * @brief Get a list of all the applications installed on the system. 584 * @brief Gets a list of all the applications installed on the system.
585 * 585 *
586 * @return An Eina_List containing all the executable files in the 586 * @return An Eina_List containing all the executable files in the
587 * system. 587 * system.
@@ -596,7 +596,7 @@ EAPI Eina_List *ecore_file_app_list(void);
596/* Download */ 596/* Download */
597 597
598/** 598/**
599 * @brief Download the given url to the given destination. 599 * @brief Downloads the given url to the given destination.
600 * 600 *
601 * @param url The complete url to download. 601 * @param url The complete url to download.
602 * @param dst The local file to save the downloaded to. 602 * @param dst The local file to save the downloaded to.
@@ -632,7 +632,7 @@ EAPI Eina_Bool ecore_file_download(const char *url,
632 Ecore_File_Download_Job **job_ret); 632 Ecore_File_Download_Job **job_ret);
633 633
634/** 634/**
635 * @brief Download the given url to the given destination with additional headers. 635 * @brief Downloads the given url to the given destination with additional headers.
636 * 636 *
637 * @param url The complete url to download. 637 * @param url The complete url to download.
638 * @param dst The local file to save the downloaded to. 638 * @param dst The local file to save the downloaded to.
@@ -652,7 +652,7 @@ EAPI Eina_Bool ecore_file_download_full(const char *url,
652 Eina_Hash *headers); 652 Eina_Hash *headers);
653 653
654/** 654/**
655 * @brief Abort all downloads. 655 * @brief Aborts all downloads.
656 * 656 *
657 * This function aborts all the downloads that have been started by 657 * This function aborts all the downloads that have been started by
658 * ecore_file_download(). It loops over the started downloads and call 658 * ecore_file_download(). It loops over the started downloads and call
@@ -662,7 +662,7 @@ EAPI Eina_Bool ecore_file_download_full(const char *url,
662EAPI void ecore_file_download_abort_all(void); 662EAPI void ecore_file_download_abort_all(void);
663 663
664/** 664/**
665 * @brief Abort the given download job and call the completion_cb 665 * @brief Aborts the given download job and call the completion_cb
666 * callbck with a status of 1 (error). 666 * callbck with a status of 1 (error).
667 * 667 *
668 * @param job The download job to abort. 668 * @param job The download job to abort.
@@ -676,7 +676,7 @@ EAPI void ecore_file_download_abort_all(void);
676EAPI void ecore_file_download_abort(Ecore_File_Download_Job *job); 676EAPI void ecore_file_download_abort(Ecore_File_Download_Job *job);
677 677
678/** 678/**
679 * @brief Check if the given protocol is available. 679 * @brief Checks if the given protocol is available.
680 * 680 *
681 * @param protocol The protocol to check. 681 * @param protocol The protocol to check.
682 * @return @c EINA_TRUE if protocol is handled, @c EINA_FALSE otherwise. 682 * @return @c EINA_TRUE if protocol is handled, @c EINA_FALSE otherwise.