summaryrefslogtreecommitdiff
path: root/legacy/eio/src
diff options
context:
space:
mode:
authorCedric BAIL <cedric.bail@free.fr>2010-10-20 12:20:06 +0000
committerCedric BAIL <cedric.bail@free.fr>2010-10-20 12:20:06 +0000
commit80cbbc23a795111227202a420f7f42cc381149eb (patch)
treeb80c4326cd1c05fa6b173cb198fde4fd464dda05 /legacy/eio/src
parentab4a53f091ca5461061e34deb74f0d4dcb802259 (diff)
* eio: more doxy fix.
SVN revision: 53658
Diffstat (limited to 'legacy/eio/src')
-rw-r--r--legacy/eio/src/lib/Eio.h25
-rw-r--r--legacy/eio/src/lib/eio_main.c8
2 files changed, 20 insertions, 13 deletions
diff --git a/legacy/eio/src/lib/Eio.h b/legacy/eio/src/lib/Eio.h
index a14748b7f3..ceda1587a1 100644
--- a/legacy/eio/src/lib/Eio.h
+++ b/legacy/eio/src/lib/Eio.h
@@ -75,15 +75,14 @@ extern "C" {
75 75
76typedef enum _Eio_File_Op 76typedef enum _Eio_File_Op
77{ 77{
78 EIO_FILE_COPY, 78 EIO_FILE_COPY, /**< IO operation is about a specific file copy */
79 EIO_FILE_MOVE, 79 EIO_FILE_MOVE, /**< IO operation is about a specific file move */
80 EIO_DIR_COPY, 80 EIO_DIR_COPY, /**< IO operation is about a specific directory copy */
81 EIO_DIR_MOVE 81 EIO_DIR_MOVE /**< IO operation is about a specific directory move */
82} Eio_File_Op; 82} Eio_File_Op;
83 83
84typedef struct _Eio_File Eio_File; 84typedef struct _Eio_File Eio_File; /**< Generic asynchronous IO reference */
85typedef struct _Eio_Progress Eio_Progress; 85typedef struct _Eio_Progress Eio_Progress; /**< Progress information on a specific operation */
86typedef struct _Eio_Stat Eio_Stat;
87 86
88typedef Eina_Bool (*Eio_Filter_Cb)(void *data, const char *file); 87typedef Eina_Bool (*Eio_Filter_Cb)(void *data, const char *file);
89typedef void (*Eio_Main_Cb)(void *data, const char *file); 88typedef void (*Eio_Main_Cb)(void *data, const char *file);
@@ -99,14 +98,14 @@ typedef void (*Eio_Error_Cb)(int error, void *data);
99 98
100struct _Eio_Progress 99struct _Eio_Progress
101{ 100{
102 Eio_File_Op op; 101 Eio_File_Op op; /**< IO type */
103 102
104 off_t current; 103 off_t current; /**< Current step in the IO operation */
105 off_t max; 104 off_t max; /**< Number of step to do to complete this IO */
106 float percent; 105 float percent; /**< Percent done of the IO operation */
107 106
108 const char *source; 107 const char *source; /**< source of the IO operation */
109 const char *dest; 108 const char *dest; /**< target of the IO operation */
110}; 109};
111 110
112EAPI int eio_init(void); 111EAPI int eio_init(void);
diff --git a/legacy/eio/src/lib/eio_main.c b/legacy/eio/src/lib/eio_main.c
index 31b5fcbb18..95c22be796 100644
--- a/legacy/eio/src/lib/eio_main.c
+++ b/legacy/eio/src/lib/eio_main.c
@@ -42,6 +42,10 @@ static Eio_Alloc_Pool direct_info = { 0, NULL, PTHREAD_MUTEX_INITIALIZER };
42 * @{ 42 * @{
43 */ 43 */
44 44
45/**
46 * @brief Initialize eio and all it's required submodule.
47 * @return the current number of eio users.
48 */
45EAPI int 49EAPI int
46eio_init(void) 50eio_init(void)
47{ 51{
@@ -55,6 +59,10 @@ eio_init(void)
55 return _eio_count; 59 return _eio_count;
56} 60}
57 61
62/**
63 * @brief Shutdown eio and all it's submodule if possible.
64 * @return the number of pending users of eio.
65 */
58EAPI int 66EAPI int
59eio_shutdown(void) 67eio_shutdown(void)
60{ 68{