summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorGustavo Sverzut Barbieri <barbieri@gmail.com>2012-12-28 20:47:25 +0000
committerGustavo Sverzut Barbieri <barbieri@gmail.com>2012-12-28 20:47:25 +0000
commit489bbff7657d480311b2827599bb21f42aac9582 (patch)
treea1a22e30c350bdf435c119501cce36a973a5e9a8 /src
parentd01565adcf76f0740ddfa487ae1050f25208c6f7 (diff)
efl/eio: fix docs.
SVN revision: 81846
Diffstat (limited to 'src')
-rw-r--r--src/lib/eio/Eio.h35
1 files changed, 28 insertions, 7 deletions
diff --git a/src/lib/eio/Eio.h b/src/lib/eio/Eio.h
index cb791a0ebf..6e24be8acd 100644
--- a/src/lib/eio/Eio.h
+++ b/src/lib/eio/Eio.h
@@ -78,16 +78,32 @@ extern "C" {
78 EAPI extern Eio_Version *eio_version; 78 EAPI extern Eio_Version *eio_version;
79 79
80/** 80/**
81 * @defgroup Eio_Group Eio Reference API 81 * @file
82 * @brief Eio asynchronous input/output library
82 * 83 *
83 * @brief This is the core asynchronous input/output operation 84 * These routines are used for Eio.
85 */
86
87/**
88 * @page eio_main Eio
89 *
90 * @section eio_intro_sec Introduction
91 *
92 * The Eio library is a library that implements an API for asynchronous
93 * input/output operation. Most operation are done in a separated thread
94 * to prevent lock. See @ref Eio_Group. Some helper to work on data
95 * received in Eio callback are also provided see @ref Eio_Helper.
96 * It is also possible to work asynchronously on Eina_File with @ref Eio_Map
97 * or on Eet_File with @ref Eio_Eet. It come with way to manipulate
98 * eXtended attribute assynchronously with @ref Eio_Xattr.
99 *
100 * This library is cross-platform and can be compiled and used on
101 * Linux, BSD, Opensolaris and Windows (XP and CE). It is heavily
102 * based on @ref Ecore_Main_Loop_Group.
84 * 103 *
85 * All the functions in this group perform input/output operations 104 * @section eio_main_intro_example Introductory Examples
86 * in a separate thread using the infrastructure provided by
87 * Ecore_Thread and Eina, this means that all functions here are non-blocking.
88 * 105 *
89 * The functions displayed here are used to make basic file operations, like 106 * @ref eio_examples
90 * listing the content of a directory, creating a new directory, etc.
91 * 107 *
92 * @{ 108 * @{
93 */ 109 */
@@ -494,6 +510,7 @@ EAPI Eio_File *eio_dir_unlink(const char *path,
494 510
495/** 511/**
496 * @defgroup Eio_Xattr Eio manipulation of eXtended attribute. 512 * @defgroup Eio_Xattr Eio manipulation of eXtended attribute.
513 * @ingroup Eio
497 * 514 *
498 * @brief A set of function to manipulate data associated with a specific file 515 * @brief A set of function to manipulate data associated with a specific file
499 * 516 *
@@ -678,6 +695,7 @@ EAPI Eio_File *eio_file_xattr_string_get(const char *path,
678 695
679/** 696/**
680 * @defgroup Eio_Helper Eio Reference helper API 697 * @defgroup Eio_Helper Eio Reference helper API
698 * @ingroup Eio
681 * 699 *
682 * @brief This are helper provided around core Eio API. 700 * @brief This are helper provided around core Eio API.
683 * 701 *
@@ -820,6 +838,7 @@ static inline Eina_Bool eio_file_is_lnk(const Eina_Stat *stat);
820 838
821/** 839/**
822 * @defgroup Eio_Map Manipulate an Eina_File asynchronously 840 * @defgroup Eio_Map Manipulate an Eina_File asynchronously
841 * @ingroup Eio
823 * 842 *
824 * @brief This function help manipulating file asynchronously. 843 * @brief This function help manipulating file asynchronously.
825 * 844 *
@@ -905,6 +924,7 @@ EAPI Eio_File *eio_file_map_new(Eina_File *f,
905 924
906/** 925/**
907 * @defgroup Eio_Eet Eio asynchronous API for Eet file. 926 * @defgroup Eio_Eet Eio asynchronous API for Eet file.
927 * @ingroup Eio
908 * 928 *
909 * @brief This set of functions help in the asynchronous use of Eet 929 * @brief This set of functions help in the asynchronous use of Eet
910 * 930 *
@@ -1096,6 +1116,7 @@ EAPI Eio_File *eio_eet_write_cipher(Eet_File *ef,
1096 1116
1097/** 1117/**
1098 * @defgroup Eio_Monitor Eio file and directory monitoring API 1118 * @defgroup Eio_Monitor Eio file and directory monitoring API
1119 * @ingroup Eio
1099 * 1120 *
1100 * @brief These function monitor changes in directories and files 1121 * @brief These function monitor changes in directories and files
1101 * 1122 *