eio: documentation for return values.

 - eio_file_copy
 - eio_file_move
 - eio_dir_copy
 - eio_dir_move
 - eio_dir_unlink

diff --git a/src/lib/eio/Eio.h b/src/lib/eio/Eio.h
index 348ed74..e120fd6 100644 (file)
--- a/src/lib/eio/Eio.h
+++ b/src/lib/eio/Eio.h
@@ -447,6 +447,8 @@ EAPI Eio_File *eio_file_mkdir(const char *path,
  * @param error_cb Callback called when something goes wrong.
  * @param data Unmodified user data passed to callbacks
  *
+ * @return an Eio_File pointer, handler to the move operation, can be used to cancel the operation
+ *
  * This function will copy a file from source to dest. It will try to use splice
  * if possible, if not it will fallback to mmap/write. It will try to preserve
  * access right, but not user/group identification.
@@ -467,6 +469,8 @@ EAPI Eio_File *eio_file_move(const char *source,
  * @param error_cb Callback called when something goes wrong.
  * @param data Unmodified user data passed to callbacks
  *
+ * @return an Eio_File pointer, handler to the copy operation, can be used to cancel the operation
+ *
  * This function will copy a file from source to dest. It will try to use splice
  * if possible, if not it will fallback to mmap/write. It will try to preserve
  * access right, but not user/group identification.
@@ -488,6 +492,8 @@ EAPI Eio_File *eio_file_copy(const char *source,
  * @param error_cb Callback called when something goes wrong.
  * @param data Unmodified user data passed to callbacks
  *
+ * @return an Eio_File pointer, handler to the move operation, can be used to cancel the operation
+ *
  * This function will move a directory and all its content from source to dest.
  * It will try first to rename the directory, if not it will try to use splice
  * if possible, if not it will fallback to mmap/write.
@@ -516,6 +522,8 @@ EAPI Eio_File *eio_dir_move(const char *source,
  * @param error_cb Callback called when something goes wrong.
  * @param data Unmodified user data passed to callbacks
  *
+ * @return an Eio_File pointer, handler to the copy operation, can be used to cancel the operation
+ *
  * This function will copy a directory and all its content from source to dest.
  * It will try to use splice if possible, if not it will fallback to mmap/write.
  * It will try to preserve access right, but not user/group identity.
@@ -540,6 +548,8 @@ EAPI Eio_File *eio_dir_copy(const char *source,
  * @param error_cb Callback called when something goes wrong.
  * @param data Unmodified user data passed to callbacks
  *
+ * @return an Eio_File pointer, handler to the unlink operation, can be used to cancel the operation
+ *
  * This function will remove a directory and all its content.
  * Every file will be passed to the filter_cb, so it's your job to decide if you
  * want to pass the file to the main_cb or not. Return EINA_TRUE to pass it to