From: caro <caro>
Date: Sat, 20 Sep 2008 08:42:35 +0000 (+0000)
Subject: finish doc of the file module. Add a warning if eina_file_split() is used
X-Git-Tag: submit/2.0alpha-wayland/20121127.222009~1871
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=cfd201572d32d4a5108719301f2da8dbf00c1898;p=profile%2Fivi%2Feina.git

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


git-svn-id: http://svn.enlightenment.org/svn/e/trunk/PROTO/eina@36122 7cbeb6ba-43b4-40fd-8cce-4c39aea84d33
---

diff --git a/src/lib/eina_file.c b/src/lib/eina_file.c
index 75ff752..669b738 100644
--- a/src/lib/eina_file.c
+++ b/src/lib/eina_file.c
@@ -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)