* eio: more doxy fix.

SVN revision: 53658
This commit is contained in:
Cedric BAIL 2010-10-20 12:20:06 +00:00
parent ab4a53f091
commit 80cbbc23a7
2 changed files with 20 additions and 13 deletions

View File

@ -75,15 +75,14 @@ extern "C" {
typedef enum _Eio_File_Op typedef enum _Eio_File_Op
{ {
EIO_FILE_COPY, EIO_FILE_COPY, /**< IO operation is about a specific file copy */
EIO_FILE_MOVE, EIO_FILE_MOVE, /**< IO operation is about a specific file move */
EIO_DIR_COPY, EIO_DIR_COPY, /**< IO operation is about a specific directory copy */
EIO_DIR_MOVE EIO_DIR_MOVE /**< IO operation is about a specific directory move */
} Eio_File_Op; } Eio_File_Op;
typedef struct _Eio_File Eio_File; typedef struct _Eio_File Eio_File; /**< Generic asynchronous IO reference */
typedef struct _Eio_Progress Eio_Progress; typedef struct _Eio_Progress Eio_Progress; /**< Progress information on a specific operation */
typedef struct _Eio_Stat Eio_Stat;
typedef Eina_Bool (*Eio_Filter_Cb)(void *data, const char *file); typedef Eina_Bool (*Eio_Filter_Cb)(void *data, const char *file);
typedef void (*Eio_Main_Cb)(void *data, const char *file); typedef void (*Eio_Main_Cb)(void *data, const char *file);
@ -99,14 +98,14 @@ typedef void (*Eio_Error_Cb)(int error, void *data);
struct _Eio_Progress struct _Eio_Progress
{ {
Eio_File_Op op; Eio_File_Op op; /**< IO type */
off_t current; off_t current; /**< Current step in the IO operation */
off_t max; off_t max; /**< Number of step to do to complete this IO */
float percent; float percent; /**< Percent done of the IO operation */
const char *source; const char *source; /**< source of the IO operation */
const char *dest; const char *dest; /**< target of the IO operation */
}; };
EAPI int eio_init(void); EAPI int eio_init(void);

View File

@ -42,6 +42,10 @@ static Eio_Alloc_Pool direct_info = { 0, NULL, PTHREAD_MUTEX_INITIALIZER };
* @{ * @{
*/ */
/**
* @brief Initialize eio and all it's required submodule.
* @return the current number of eio users.
*/
EAPI int EAPI int
eio_init(void) eio_init(void)
{ {
@ -55,6 +59,10 @@ eio_init(void)
return _eio_count; return _eio_count;
} }
/**
* @brief Shutdown eio and all it's submodule if possible.
* @return the number of pending users of eio.
*/
EAPI int EAPI int
eio_shutdown(void) eio_shutdown(void)
{ {