aboutsummaryrefslogtreecommitdiffstats
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)
downloadefl-489bbff7657d480311b2827599bb21f42aac9582.tar.gz
efl-489bbff7657d480311b2827599bb21f42aac9582.tar.xz
efl-489bbff7657d480311b2827599bb21f42aac9582.zip
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 260147dbd..2c00f2d4f 100644
--- a/doc/Doxyfile.in
+++ b/doc/Doxyfile.in
@@ -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
diff --git a/doc/eio.dox.in b/doc/eio_examples.dox
index de25ae673..a0f132504 100644
--- a/doc/eio.dox.in
+++ b/doc/eio_examples.dox
@@ -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
- *
- * @section eio_intro_sec Introduction
- * @version @PACKAGE_VERSION@
- *
- * 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).
+ * @page eio_examples Eio Examples
+ *
+ * Here is a page with some Eio examples explained:
+ *
+ * @li @ref eio_file_ls.c
+ *
+ * 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
*/
/**
diff --git a/doc/main.dox b/doc/main.dox
index 070239b4f..950f80563 100644
--- a/doc/main.dox
+++ b/doc/main.dox
@@ -14,6 +14,7 @@
* @li @ref ecore_main
* @li @ref escape_main
* @li @ref evil_main
+ * @li @ref eio_main
* @li @ref edbus_main
*
*/
@@ -159,6 +160,12 @@
*/
/**
+ * @defgroup Eio
+ *
+ * @brief Eio
+ */
+
+/**
* @defgroup EDBus
*
* @brief EDBus