summaryrefslogtreecommitdiff
path: root/src/lib/ecore
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/ecore
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/ecore')
-rw-r--r--src/lib/ecore/Ecore.h82
1 files changed, 50 insertions, 32 deletions
diff --git a/src/lib/ecore/Ecore.h b/src/lib/ecore/Ecore.h
index 448e1aca1f..34210f932e 100644
--- a/src/lib/ecore/Ecore.h
+++ b/src/lib/ecore/Ecore.h
@@ -8,10 +8,14 @@
8 8
9 @page ecore_main Ecore 9 @page ecore_main Ecore
10 10
11 @version 1.7 11 @date 2000 (created)
12 @date 2000-2012
13 12
14 Please see the @ref authors page for contact details. 13 @section toc Table of Contents
14
15 @li @ref ecore_main_intro
16 @li @ref ecore_main_compiling
17 @li @ref ecore_main_next_steps
18 @li @ref ecore_main_intro_example
15 19
16 @section ecore_main_intro Introduction 20 @section ecore_main_intro Introduction
17 21
@@ -36,35 +40,49 @@
36 40
37 For more info on Ecore usage, there are these @ref ecore_examples. 41 For more info on Ecore usage, there are these @ref ecore_examples.
38 42
39 @section ecore_main_compiling How to compile using Ecore? 43 @section ecore_main_compiling How to compile
40 pkgconfig (.pc) files are installed for every ecore module. 44
41 Thus, to compile using any of them, you can use something like the following: 45 Ecore is a library your application links to. The procedure for
42 46 this is very simple. You simply have to compile your application
43@verbatim 47 with the appropriate compiler flags that the @p pkg-config script
44gcc *.c $(pkg-config ecore ecore-$x ecore-$y [...] --cflags --libs) 48 outputs. Note that each module is separate in pkg-config. For
45@endverbatim 49 example using @ref Ecore_Evas_Group:
46 50
47 @section ecore_main_install How is it installed? 51 Compiling C or C++ files into object files:
48 52
49 Suggested configure options for ecore for a Linux desktop X display 53 @verbatim
50 with OpenGL and Software support, communication (networking) and 54 gcc -c -o main.o main.c `pkg-config --cflags ecore ecore-evas`
51 IPC (inter process communication): 55 @endverbatim
52 56
53@verbatim 57 Linking object files into a binary executable:
54./configure \ 58
55 --enable-ecore-con \ 59 @verbatim
56 --enable-ecore-ipc \ 60 gcc -o my_application main.o `pkg-config --libs ecore ecore-evas`
57 --enable-ecore-file \ 61 @endverbatim
58 --enable-ecore-input \ 62
59 --enable-ecore-input-evas \ 63 See @ref pkgconfig
60 --enable-ecore-x \ 64
61 --enable-ecore-evas \ 65 @section ecore_main_next_steps Next Steps
62 --enable-ecore-evas-software-buffer \ 66
63 --enable-ecore-evas-software-x11 \ 67 After you understood what Ecore is and installed it in your system
64 --enable-ecore-evas-opengl-x11 68 you should proceed understanding the programming interface. We'd
65make 69 recommend you to take a while to learn @ref Eina as it is very
66sudo make install 70 convenient and optimized, and Ecore uses it extensively.
67@endverbatim 71
72 Recommended reading:
73
74 @li @ref Ecore_Timer_Group
75 @li @ref Ecore_Idle_Group
76 @li @ref Ecore_FD_Handler_Group
77 @li @ref Ecore_Event_Group
78 @li @ref Ecore_Exe_Group
79
80 @section ecore_main_intro_example Introductory Examples
81
82 @include ecore_timer_example.c
83
84 More examples can be found at @ref ecore_examples.
85
68 86
69 */ 87 */
70 88