From 0304666261fe9446b17068188580da8899241703 Mon Sep 17 00:00:00 2001 From: Vincent Torri Date: Tue, 12 Oct 2010 14:59:30 +0000 Subject: [PATCH] improve doc. Now, cedric, it's up to you :p SVN revision: 53308 --- legacy/eio/src/lib/Eio.h | 24 ++++++++++++++++++++++++ legacy/eio/src/lib/eio_dir.c | 10 ++++++++++ legacy/eio/src/lib/eio_file.c | 11 +++++++++++ legacy/eio/src/lib/eio_main.c | 10 ++++++++++ legacy/eio/src/lib/eio_single.c | 11 +++++++++-- 5 files changed, 64 insertions(+), 2 deletions(-) diff --git a/legacy/eio/src/lib/Eio.h b/legacy/eio/src/lib/Eio.h index a456132449..a14748b7f3 100644 --- a/legacy/eio/src/lib/Eio.h +++ b/legacy/eio/src/lib/Eio.h @@ -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 diff --git a/legacy/eio/src/lib/eio_dir.c b/legacy/eio/src/lib/eio_dir.c index a33e803c16..6578d66487 100644 --- a/legacy/eio/src/lib/eio_dir.c +++ b/legacy/eio/src/lib/eio_dir.c @@ -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 ©->progress.common; } +/** + * @} + */ diff --git a/legacy/eio/src/lib/eio_file.c b/legacy/eio/src/lib/eio_file.c index 2f244ab192..fadd3eed89 100644 --- a/legacy/eio/src/lib/eio_file.c +++ b/legacy/eio/src/lib/eio_file.c @@ -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; } + +/** + * @} + */ diff --git a/legacy/eio/src/lib/eio_main.c b/legacy/eio/src/lib/eio_main.c index 25b2032e19..e600d7355e 100644 --- a/legacy/eio/src/lib/eio_main.c +++ b/legacy/eio/src/lib/eio_main.c @@ -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); } +/** + * @} + */ diff --git a/legacy/eio/src/lib/eio_single.c b/legacy/eio/src/lib/eio_single.c index 21d326ef39..af5b6a7ad1 100644 --- a/legacy/eio/src/lib/eio_single.c +++ b/legacy/eio/src/lib/eio_single.c @@ -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; } - +/** + * @} + */