summaryrefslogtreecommitdiff
path: root/src/lib/evil
diff options
context:
space:
mode:
authorStefan Schmidt <s.schmidt@samsung.com>2019-10-02 12:23:38 +0200
committerStefan Schmidt <s.schmidt@samsung.com>2019-10-07 12:50:12 +0200
commitb4e943ef3ea6f7c0830558ba10f2499c456b1556 (patch)
treec0491116de947fe10524525e0558dd2cbf2de8fd /src/lib/evil
parent34fa84a1711599ac02239b7d32cb9b24bad350a0 (diff)
evil: bring back doxygen intro page for evil library
While we switched evil to be not a public AP, but internal lib only, we still want to have its documentation shown. Reviewed-by: Vincent Torri <vincent.torri@gmail.com> Differential Revision: https://phab.enlightenment.org/D10270
Diffstat (limited to 'src/lib/evil')
-rw-r--r--src/lib/evil/evil_main.h74
1 files changed, 74 insertions, 0 deletions
diff --git a/src/lib/evil/evil_main.h b/src/lib/evil/evil_main.h
index 963bf5e..7c1f67d 100644
--- a/src/lib/evil/evil_main.h
+++ b/src/lib/evil/evil_main.h
@@ -1,6 +1,80 @@
1#ifndef __EVIL_MAIN_H__ 1#ifndef __EVIL_MAIN_H__
2#define __EVIL_MAIN_H__ 2#define __EVIL_MAIN_H__
3 3
4/**
5 * @page evil_main Evil
6 * @author Vincent Torri
7 * @date 2008 (created)
8 *
9 * @section toc Table of Contents
10 *
11 * @li @ref evil_main_intro
12 * @li @ref evil_main_ack
13 * @li @ref evil_main_compiling
14 * @li @ref evil_main_next_steps
15 *
16 * @section evil_main_intro Introduction
17 *
18 * The Evil library is an evil library that ports some evil Unix
19 * functions to the Windows (XP or above, or Mobile) platform. The
20 * evilness is so huge that the most of the functions are not POSIX or
21 * BSD compliant.
22 *
23 * These functions are intended to be used in the Enlightenment
24 * Foundation Libraries only and can be compiled only on Windows,
25 * using MSYS/MinGW on Windows, and cross-compilation on Unix. This
26 * library is minimal in the sense that only the functions needed to
27 * compile the EFL are available. The purpose of this library is NOT
28 * to have a full POSIX emulation et it is NOT a replacement of
29 * cygwin. To compare the size of the DLL themselves, Evil is around
30 * 33 KB and cygwin DLL is around 800 KB.
31 *
32 * @section evil_main_ack Acknowledgments
33 *
34 * This library has receive some from people interested in the EFL or
35 * not. Among them, evil thanks to Lars Munch, Raoul Hecky, Nicolas
36 * Aguirre, Tor Lillqvist, Lance Fetters, Vincent Richomme, Paul
37 * Vixie, Daniel Stenberg, who helped the author of the library in
38 * different fields (code and tests).
39 *
40 * @section evil_main_compiling How to compile
41 *
42 * Evil is a library your application links to. The procedure for
43 * this is very simple. You simply have to compile your application
44 * with the appropriate compiler flags that the @p pkg-config script
45 * outputs. For example:
46 *
47 * Compiling C or C++ files into object files:
48 *
49 * @verbatim
50 gcc -c -o main.o main.c `pkg-config --cflags evil`
51 @endverbatim
52 *
53 * Linking object files into a binary executable:
54 *
55 * @verbatim
56 gcc -o my_application main.o `pkg-config --libs evil`
57 @endverbatim
58 *
59 * See @ref pkgconfig
60 *
61 * @section evil_main_next_steps Next Steps
62 *
63 * After you understood what Evil is and installed it in your system
64 * you should proceed understanding the programming interface.
65 *
66 * Recommended reading:
67 *
68 * @li @ref Evil_Mman
69 * @li @ref Evil_Unistd_Group
70 * @li @ref Evil_Dlfcn
71 * @li @ref Evil_Locale_Group
72 * @li @ref Evil_Stdio_Group
73 * @li @ref Evil_Main_Group
74 * @li @ref Evil_String_Group
75 * @li @ref Evil_Stdlib_Group
76 * @li @ref Evil_Time_Group
77 */
4 78
5/** 79/**
6 * @file evil_main.h 80 * @file evil_main.h