summaryrefslogtreecommitdiff
path: root/src/lib/evil
diff options
context:
space:
mode:
authorGustavo Sverzut Barbieri <barbieri@gmail.com>2012-12-28 23:26:05 +0000
committerGustavo Sverzut Barbieri <barbieri@gmail.com>2012-12-28 23:26:05 +0000
commit2608f68571b277967b2e27d6136c95f03befd183 (patch)
tree24a3b2764432b9fbde980aabf6bc40e7c74b1610 /src/lib/evil
parent4f6a4e59a4e7774fe55ae3ecf37d42faabec07e4 (diff)
efl/docs: clean-up and make it more uniform.
now unified docs are bit more uniform in their start pages, overall improved but much to do :-( SVN revision: 81851
Diffstat (limited to 'src/lib/evil')
-rw-r--r--src/lib/evil/Evil.h57
1 files changed, 47 insertions, 10 deletions
diff --git a/src/lib/evil/Evil.h b/src/lib/evil/Evil.h
index 191aae9c12..0aad5f0613 100644
--- a/src/lib/evil/Evil.h
+++ b/src/lib/evil/Evil.h
@@ -9,10 +9,16 @@
9/** 9/**
10 * @page evil_main Evil 10 * @page evil_main Evil
11 * @author Vincent Torri 11 * @author Vincent Torri
12 * @version 1.7.0 12 * @date 2008 (created)
13 * @date 2008-2012
14 * 13 *
15 * @section intro_sec Introduction 14 * @section toc Table of Contents
15 *
16 * @li @ref evil_main_intro
17 * @li @ref evil_main_ack
18 * @li @ref evil_main_compiling
19 * @li @ref evil_main_next_steps
20 *
21 * @section evil_main_intro Introduction
16 * 22 *
17 * The Evil library is an evil library that ports some evil Unix 23 * The Evil library is an evil library that ports some evil Unix
18 * functions to the Windows (XP or above, or Mobile) platform. The 24 * functions to the Windows (XP or above, or Mobile) platform. The
@@ -28,7 +34,7 @@
28 * cygwin. To compare the size of the DLL themselves, Evil is around 34 * cygwin. To compare the size of the DLL themselves, Evil is around
29 * 33 KB and cygwin DLL is around 800 KB. 35 * 33 KB and cygwin DLL is around 800 KB.
30 * 36 *
31 * @section acknowledgments_sec Acknowledgments 37 * @section evil_main_ack Acknowledgments
32 * 38 *
33 * This library has receive some from people interested in the EFL or 39 * This library has receive some from people interested in the EFL or
34 * not. Among them, evil thanks to Lars Munch, Raoul Hecky, Nicolas 40 * not. Among them, evil thanks to Lars Munch, Raoul Hecky, Nicolas
@@ -36,15 +42,46 @@
36 * Vixie, Daniel Stenberg, who helped the author of the library in 42 * Vixie, Daniel Stenberg, who helped the author of the library in
37 * different fields (code and tests). 43 * different fields (code and tests).
38 * 44 *
39 * @section license_sec license 45 * @section evil_main_compiling How to compile
46 *
47 * Evil is a library your application links to. The procedure for
48 * this is very simple. You simply have to compile your application
49 * with the appropriate compiler flags that the @p pkg-config script
50 * outputs. For example:
51 *
52 * Compiling C or C++ files into object files:
53 *
54 * @verbatim
55 gcc -c -o main.o main.c `pkg-config --cflags evil`
56 @endverbatim
57 *
58 * Linking object files into a binary executable:
59 *
60 * @verbatim
61 gcc -o my_application main.o `pkg-config --libs evil`
62 @endverbatim
63 *
64 * See @ref pkgconfig
65 *
66 * @section evil_main_next_steps Next Steps
40 * 67 *
41 * The Evil library is distributes under a modified BSD license. See 68 * After you understood what Evil is and installed it in your system
42 * the files COPYING and COPYING-PLAIN in the top level directory for 69 * you should proceed understanding the programming interface.
43 * the full license text.
44 * 70 *
45 * @section reference_sec Reference API 71 * Recommended reading:
46 * 72 *
47 * Use the horizontal menu above to navigate into the reference API 73 * @li @ref Evil_Mman
74 * @li @ref Evil_Libgen_Group
75 * @li @ref Evil_Unistd_Group
76 * @li @ref Evil_Dlfcn
77 * @li @ref Evil_Pwd_Group
78 * @li @ref Evil_Stdio_Group
79 * @li @ref Evil_Main_Group
80 * @li @ref Evil_Inet_Group
81 * @li @ref Evil_Dirent_Group
82 * @li @ref Evil_String_Group
83 * @li @ref Evil_Stdlib_Group
84 * @li @ref Evil_Time_Group
48 */ 85 */
49 86
50/** 87/**