forked from enlightenment/efl
parent
d01565adcf
commit
489bbff765
|
@ -598,8 +598,7 @@ INPUT = @top_srcdir@/src/lib \
|
|||
@srcdir@/eet_examples.dox \
|
||||
@srcdir@/evas_examples.dox \
|
||||
@srcdir@/eo_tutorial.dox \
|
||||
@builddir@/eio.dox \
|
||||
@builddir@/edbus.dox
|
||||
@srcdir@/eio_examples.dox
|
||||
|
||||
# This tag can be used to specify the character encoding of the source files
|
||||
# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
|
||||
|
|
|
@ -1,47 +1,18 @@
|
|||
/* EIO - EFL data type library
|
||||
* Copyright (C) 2010 Enlightenment Developers:
|
||||
* Cedric Bail <cedric.bail@free.fr>
|
||||
* Vincent "caro" Torri <vtorri at univ-evry dot fr>
|
||||
* Stephen "okra" Houston <unixtitan@gmail.com>
|
||||
* Gustavo Sverzut Barbieri <barbieri@gmail.com>
|
||||
*
|
||||
* This library is free software; you can redistribute it and/or
|
||||
* modify it under the terms of the GNU Lesser General Public
|
||||
* License as published by the Free Software Foundation; either
|
||||
* version 2.1 of the License, or (at your option) any later version.
|
||||
*
|
||||
* This library is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
||||
* Lesser General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Lesser General Public
|
||||
* License along with this library;
|
||||
* if not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
/**
|
||||
* @page eio_main Eio
|
||||
* @author Cedric Bail <cedric.bail@@free.fr>
|
||||
* @author Stephen "okra" Houston <unixtitan@@gmail.com>
|
||||
* @author Gustavo Sverzut Barbieri <barbieri@@gmail.com>
|
||||
* @author Vincent "caro" Torri <vtorri at univ-evry dot fr>
|
||||
* @author Guillaume "kuri" Friloux <guillaume.friloux@@asp64.com>
|
||||
* @date 2010-2012
|
||||
* @page eio_examples Eio Examples
|
||||
*
|
||||
* @section eio_intro_sec Introduction
|
||||
* @version @PACKAGE_VERSION@
|
||||
* Here is a page with some Eio examples explained:
|
||||
*
|
||||
* The Eio library is a library that implements an API for asynchronous
|
||||
* input/output operation. Most operation are done in a separated thread
|
||||
* to prevent lock. See @ref Eio_Group. Some helper to work on data
|
||||
* received in Eio callback are also provided see @ref Eio_Helper.
|
||||
* It is also possible to work asynchronously on Eina_File with @ref Eio_Map
|
||||
* or on Eet_File with @ref Eio_Eet. It come with way to manipulate
|
||||
* eXtended attribute assynchronously with @ref Eio_Xattr.
|
||||
* @li @ref eio_file_ls.c
|
||||
*
|
||||
* This library is cross-platform and can be compiled and used on
|
||||
* Linux, BSD, Opensolaris and Windows (XP and CE).
|
||||
* Tutorials:
|
||||
* @li @ref tutorial_dir_copy
|
||||
* @li @ref tutorial_dir_stat_ls
|
||||
* @li @ref tutorial_file_ls
|
||||
* @li @ref tutorial_dir_direct_ls
|
||||
* @li @ref tutorial_monitor_add
|
||||
*
|
||||
* @example eio_file_ls.c
|
||||
*/
|
||||
|
||||
/**
|
|
@ -14,6 +14,7 @@
|
|||
* @li @ref ecore_main
|
||||
* @li @ref escape_main
|
||||
* @li @ref evil_main
|
||||
* @li @ref eio_main
|
||||
* @li @ref edbus_main
|
||||
*
|
||||
*/
|
||||
|
@ -158,6 +159,12 @@
|
|||
* @brief Ecore
|
||||
*/
|
||||
|
||||
/**
|
||||
* @defgroup Eio
|
||||
*
|
||||
* @brief Eio
|
||||
*/
|
||||
|
||||
/**
|
||||
* @defgroup EDBus
|
||||
*
|
||||
|
|
|
@ -78,16 +78,32 @@ extern "C" {
|
|||
EAPI extern Eio_Version *eio_version;
|
||||
|
||||
/**
|
||||
* @defgroup Eio_Group Eio Reference API
|
||||
* @file
|
||||
* @brief Eio asynchronous input/output library
|
||||
*
|
||||
* @brief This is the core asynchronous input/output operation
|
||||
* These routines are used for Eio.
|
||||
*/
|
||||
|
||||
/**
|
||||
* @page eio_main Eio
|
||||
*
|
||||
* All the functions in this group perform input/output operations
|
||||
* in a separate thread using the infrastructure provided by
|
||||
* Ecore_Thread and Eina, this means that all functions here are non-blocking.
|
||||
* @section eio_intro_sec Introduction
|
||||
*
|
||||
* The functions displayed here are used to make basic file operations, like
|
||||
* listing the content of a directory, creating a new directory, etc.
|
||||
* The Eio library is a library that implements an API for asynchronous
|
||||
* input/output operation. Most operation are done in a separated thread
|
||||
* to prevent lock. See @ref Eio_Group. Some helper to work on data
|
||||
* received in Eio callback are also provided see @ref Eio_Helper.
|
||||
* It is also possible to work asynchronously on Eina_File with @ref Eio_Map
|
||||
* or on Eet_File with @ref Eio_Eet. It come with way to manipulate
|
||||
* eXtended attribute assynchronously with @ref Eio_Xattr.
|
||||
*
|
||||
* This library is cross-platform and can be compiled and used on
|
||||
* Linux, BSD, Opensolaris and Windows (XP and CE). It is heavily
|
||||
* based on @ref Ecore_Main_Loop_Group.
|
||||
*
|
||||
* @section eio_main_intro_example Introductory Examples
|
||||
*
|
||||
* @ref eio_examples
|
||||
*
|
||||
* @{
|
||||
*/
|
||||
|
@ -494,6 +510,7 @@ EAPI Eio_File *eio_dir_unlink(const char *path,
|
|||
|
||||
/**
|
||||
* @defgroup Eio_Xattr Eio manipulation of eXtended attribute.
|
||||
* @ingroup Eio
|
||||
*
|
||||
* @brief A set of function to manipulate data associated with a specific file
|
||||
*
|
||||
|
@ -678,6 +695,7 @@ EAPI Eio_File *eio_file_xattr_string_get(const char *path,
|
|||
|
||||
/**
|
||||
* @defgroup Eio_Helper Eio Reference helper API
|
||||
* @ingroup Eio
|
||||
*
|
||||
* @brief This are helper provided around core Eio API.
|
||||
*
|
||||
|
@ -820,6 +838,7 @@ static inline Eina_Bool eio_file_is_lnk(const Eina_Stat *stat);
|
|||
|
||||
/**
|
||||
* @defgroup Eio_Map Manipulate an Eina_File asynchronously
|
||||
* @ingroup Eio
|
||||
*
|
||||
* @brief This function help manipulating file asynchronously.
|
||||
*
|
||||
|
@ -905,6 +924,7 @@ EAPI Eio_File *eio_file_map_new(Eina_File *f,
|
|||
|
||||
/**
|
||||
* @defgroup Eio_Eet Eio asynchronous API for Eet file.
|
||||
* @ingroup Eio
|
||||
*
|
||||
* @brief This set of functions help in the asynchronous use of Eet
|
||||
*
|
||||
|
@ -1096,6 +1116,7 @@ EAPI Eio_File *eio_eet_write_cipher(Eet_File *ef,
|
|||
|
||||
/**
|
||||
* @defgroup Eio_Monitor Eio file and directory monitoring API
|
||||
* @ingroup Eio
|
||||
*
|
||||
* @brief These function monitor changes in directories and files
|
||||
*
|
||||
|
|
Loading…
Reference in New Issue