improve doc. Now, cedric, it's up to you :p

SVN revision: 53308
This commit is contained in:
Vincent Torri 2010-10-12 14:59:30 +00:00
parent 96185ffaf5
commit 0304666261
5 changed files with 64 additions and 2 deletions

View File

@ -58,6 +58,21 @@
# endif
#endif /* ! _WIN32 */
#ifdef __cplusplus
extern "C" {
#endif
/**
* @defgroup Eio_Group Asynchronous Inout/Output library
*
* @brief A brief description
*
* A long description
*
* @{
*/
typedef enum _Eio_File_Op
{
EIO_FILE_COPY,
@ -163,4 +178,13 @@ EAPI Eio_File *eio_dir_unlink(const char *path,
EAPI Eina_Bool eio_file_cancel(Eio_File *ls);
/**
* @}
*/
#ifdef __cplusplus
}
#endif
#endif

View File

@ -281,6 +281,13 @@ _eio_dir_copy_error(void *data)
_eio_dir_copy_free(copy);
}
/**
* @addtogroup Eio_Group Asynchronous Inout/Output library
*
* @{
*/
/**
* @brief Copy a directory and it's content asynchronously
* @param source Should be the name of the directory to copy the data from.
@ -331,3 +338,6 @@ eio_dir_copy(const char *source,
return &copy->progress.common;
}
/**
* @}
*/

View File

@ -510,6 +510,13 @@ _eio_file_move_error(void *data)
_eio_file_move_free(move);
}
/**
* @addtogroup Eio_Group Asynchronous Inout/Output library
*
* @{
*/
/**
* @brief List content of a directory without locking your app.
* @param dir The directory to list.
@ -718,3 +725,7 @@ eio_file_move(const char *source,
return &move->progress.common;
}
/**
* @}
*/

View File

@ -44,6 +44,13 @@ struct _Eio_Alloc_Pool
static Eio_Alloc_Pool progress = { 0, NULL, PTHREAD_MUTEX_INITIALIZER };
static Eio_Alloc_Pool direct_info = { 0, NULL, PTHREAD_MUTEX_INITIALIZER };
/**
* @addtogroup Eio_Group Asynchronous Inout/Output library
*
* @{
*/
EAPI int
eio_init(void)
{
@ -162,3 +169,6 @@ eio_direct_info_free(Eina_File_Direct_Info *data)
_eio_pool_free(&direct_info, data);
}
/**
* @}
*/

View File

@ -210,7 +210,12 @@ _eio_file_stat_error(void *data)
_eio_stat_free(s);
}
/* ---- */
/**
* @addtogroup Eio_Group Asynchronous Inout/Output library
*
* @{
*/
/**
* @brief Stat a file/directory.
@ -326,4 +331,6 @@ eio_file_mkdir(const char *path,
return &r->common;
}
/**
* @}
*/