summaryrefslogtreecommitdiff
path: root/doc
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 /doc
parentd01565adcf76f0740ddfa487ae1050f25208c6f7 (diff)
efl/eio: fix docs.
SVN revision: 81846
Diffstat (limited to 'doc')
-rw-r--r--doc/Doxyfile.in3
-rw-r--r--doc/eio_examples.dox (renamed from doc/eio.dox.in)57
-rw-r--r--doc/main.dox7
3 files changed, 22 insertions, 45 deletions
diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in
index 260147dbdb..2c00f2d4fa 100644
--- a/doc/Doxyfile.in
+++ b/doc/Doxyfile.in
@@ -598,8 +598,7 @@ INPUT = @top_srcdir@/src/lib \
598 @srcdir@/eet_examples.dox \ 598 @srcdir@/eet_examples.dox \
599 @srcdir@/evas_examples.dox \ 599 @srcdir@/evas_examples.dox \
600 @srcdir@/eo_tutorial.dox \ 600 @srcdir@/eo_tutorial.dox \
601 @builddir@/eio.dox \ 601 @srcdir@/eio_examples.dox
602 @builddir@/edbus.dox
603 602
604# This tag can be used to specify the character encoding of the source files 603# This tag can be used to specify the character encoding of the source files
605# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is 604# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
diff --git a/doc/eio.dox.in b/doc/eio_examples.dox
index de25ae6730..a0f1325045 100644
--- a/doc/eio.dox.in
+++ b/doc/eio_examples.dox
@@ -1,47 +1,18 @@
1/* EIO - EFL data type library
2 * Copyright (C) 2010 Enlightenment Developers:
3 * Cedric Bail <cedric.bail@free.fr>
4 * Vincent "caro" Torri <vtorri at univ-evry dot fr>
5 * Stephen "okra" Houston <unixtitan@gmail.com>
6 * Gustavo Sverzut Barbieri <barbieri@gmail.com>
7 *
8 * This library is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Lesser General Public
10 * License as published by the Free Software Foundation; either
11 * version 2.1 of the License, or (at your option) any later version.
12 *
13 * This library is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * Lesser General Public License for more details.
17 *
18 * You should have received a copy of the GNU Lesser General Public
19 * License along with this library;
20 * if not, see <http://www.gnu.org/licenses/>.
21 */
22
23/** 1/**
24 * @page eio_main Eio 2 * @page eio_examples Eio Examples
25 * @author Cedric Bail <cedric.bail@@free.fr> 3 *
26 * @author Stephen "okra" Houston <unixtitan@@gmail.com> 4 * Here is a page with some Eio examples explained:
27 * @author Gustavo Sverzut Barbieri <barbieri@@gmail.com> 5 *
28 * @author Vincent "caro" Torri <vtorri at univ-evry dot fr> 6 * @li @ref eio_file_ls.c
29 * @author Guillaume "kuri" Friloux <guillaume.friloux@@asp64.com> 7 *
30 * @date 2010-2012 8 * Tutorials:
31 * 9 * @li @ref tutorial_dir_copy
32 * @section eio_intro_sec Introduction 10 * @li @ref tutorial_dir_stat_ls
33 * @version @PACKAGE_VERSION@ 11 * @li @ref tutorial_file_ls
34 * 12 * @li @ref tutorial_dir_direct_ls
35 * The Eio library is a library that implements an API for asynchronous 13 * @li @ref tutorial_monitor_add
36 * input/output operation. Most operation are done in a separated thread 14 *
37 * to prevent lock. See @ref Eio_Group. Some helper to work on data 15 * @example eio_file_ls.c
38 * received in Eio callback are also provided see @ref Eio_Helper.
39 * It is also possible to work asynchronously on Eina_File with @ref Eio_Map
40 * or on Eet_File with @ref Eio_Eet. It come with way to manipulate
41 * eXtended attribute assynchronously with @ref Eio_Xattr.
42 *
43 * This library is cross-platform and can be compiled and used on
44 * Linux, BSD, Opensolaris and Windows (XP and CE).
45 */ 16 */
46 17
47/** 18/**
diff --git a/doc/main.dox b/doc/main.dox
index 070239b4f1..950f805635 100644
--- a/doc/main.dox
+++ b/doc/main.dox
@@ -14,6 +14,7 @@
14 * @li @ref ecore_main 14 * @li @ref ecore_main
15 * @li @ref escape_main 15 * @li @ref escape_main
16 * @li @ref evil_main 16 * @li @ref evil_main
17 * @li @ref eio_main
17 * @li @ref edbus_main 18 * @li @ref edbus_main
18 * 19 *
19 */ 20 */
@@ -159,6 +160,12 @@
159 */ 160 */
160 161
161/** 162/**
163 * @defgroup Eio
164 *
165 * @brief Eio
166 */
167
168/**
162 * @defgroup EDBus 169 * @defgroup EDBus
163 * 170 *
164 * @brief EDBus 171 * @brief EDBus