kimcinoo
/
efl
forked from enlightenment/efl
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

finish doc of the file module. Add a warning if eina_file_split() is used 

SVN revision: 36122
This commit is contained in:
Vincent Torri 2008-09-20 08:42:35 +00:00
parent 8c5d095827
commit f196383f8f
1 changed files with 14 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
legacy/eina/src/lib/eina_file.c
View File

@ -78,9 +78,17 @@ void *alloca (size_t);
/**
* @addtogroup Eina_File_Group Memory File
*
* @brief Functions to traverse directories and split paths
* @brief Functions to traverse directories and split paths.
*
* To be documented...
* @li eina_file_dir_list() list the content of a directory,
* recusrsively or not, and can call a callback function for eachfound
* file.
* @li eina_file_split() split a path into all the subdirectories that
* compose it, according to the separator of the file system.
*
* @warning eina_file_split() uses the @ref Eina_Array_Group module
* but does not initialize it. eina_array_init() and
* eina_array_shutdown() must be called if this function is used.
*
* @{
*/
@ -225,6 +233,10 @@ eina_file_dir_list(const char *dir, Eina_Bool recursive, Eina_File_Dir_List_Cb c
* filesystem. If @p path is @c NULL or if the array can not be
* created, @c NULL is returned, otherwise, an array with the
* different parts of @p path is returned.
*
* @warning This function uses the @ref Eina_Array_Group module but
* does not initialize it. eina_array_init() and eina_array_shutdown()
* must be called if this function is used.
*/
EAPI Eina_Array *
eina_file_split(char *path)