aboutsummaryrefslogtreecommitdiffstats
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
parentecore : fix incorrect size of expression for coverity (diff)
downloadefl-b4e943ef3ea6f7c0830558ba10f2499c456b1556.tar.gz
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
-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 963bf5e7c6..7c1f67d215 100644
--- a/src/lib/evil/evil_main.h
+++ b/src/lib/evil/evil_main.h
@@ -1,6 +1,80 @@
#ifndef __EVIL_MAIN_H__
#define __EVIL_MAIN_H__
+/**
+ * @page evil_main Evil
+ * @author Vincent Torri
+ * @date 2008 (created)
+ *
+ * @section toc Table of Contents
+ *
+ * @li @ref evil_main_intro
+ * @li @ref evil_main_ack
+ * @li @ref evil_main_compiling
+ * @li @ref evil_main_next_steps
+ *
+ * @section evil_main_intro Introduction
+ *
+ * The Evil library is an evil library that ports some evil Unix
+ * functions to the Windows (XP or above, or Mobile) platform. The
+ * evilness is so huge that the most of the functions are not POSIX or
+ * BSD compliant.
+ *
+ * These functions are intended to be used in the Enlightenment
+ * Foundation Libraries only and can be compiled only on Windows,
+ * using MSYS/MinGW on Windows, and cross-compilation on Unix. This
+ * library is minimal in the sense that only the functions needed to
+ * compile the EFL are available. The purpose of this library is NOT
+ * to have a full POSIX emulation et it is NOT a replacement of
+ * cygwin. To compare the size of the DLL themselves, Evil is around
+ * 33 KB and cygwin DLL is around 800 KB.
+ *
+ * @section evil_main_ack Acknowledgments
+ *
+ * This library has receive some from people interested in the EFL or
+ * not. Among them, evil thanks to Lars Munch, Raoul Hecky, Nicolas
+ * Aguirre, Tor Lillqvist, Lance Fetters, Vincent Richomme, Paul
+ * Vixie, Daniel Stenberg, who helped the author of the library in
+ * different fields (code and tests).
+ *
+ * @section evil_main_compiling How to compile
+ *
+ * Evil is a library your application links to. The procedure for
+ * this is very simple. You simply have to compile your application
+ * with the appropriate compiler flags that the @p pkg-config script
+ * outputs. For example:
+ *
+ * Compiling C or C++ files into object files:
+ *
+ * @verbatim
+ gcc -c -o main.o main.c `pkg-config --cflags evil`
+ @endverbatim
+ *
+ * Linking object files into a binary executable:
+ *
+ * @verbatim
+ gcc -o my_application main.o `pkg-config --libs evil`
+ @endverbatim
+ *
+ * See @ref pkgconfig
+ *
+ * @section evil_main_next_steps Next Steps
+ *
+ * After you understood what Evil is and installed it in your system
+ * you should proceed understanding the programming interface.
+ *
+ * Recommended reading:
+ *
+ * @li @ref Evil_Mman
+ * @li @ref Evil_Unistd_Group
+ * @li @ref Evil_Dlfcn
+ * @li @ref Evil_Locale_Group
+ * @li @ref Evil_Stdio_Group
+ * @li @ref Evil_Main_Group
+ * @li @ref Evil_String_Group
+ * @li @ref Evil_Stdlib_Group
+ * @li @ref Evil_Time_Group
+ */
/**
* @file evil_main.h