summaryrefslogtreecommitdiff
path: root/src/lib/evas/Evas.h
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/evas/Evas.h
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/evas/Evas.h')
-rw-r--r--src/lib/evas/Evas.h61
1 files changed, 16 insertions, 45 deletions
diff --git a/src/lib/evas/Evas.h b/src/lib/evas/Evas.h
index bf58ec5..2b82d9e 100644
--- a/src/lib/evas/Evas.h
+++ b/src/lib/evas/Evas.h
@@ -1,25 +1,18 @@
1/** 1/**
2 @page evas_main Evas 2 @page evas_main Evas
3 3
4 @version 1.7 4 @date 2000 (created)
5 @date 2000-2012
6
7 Please see the @ref authors page for contact details.
8 @link Evas.h Evas API @endlink
9
10 @link Evas.h Evas API @endlink
11 5
12 @section toc Table of Contents 6 @section toc Table of Contents
13 7
14 @li @ref evas_main_intro 8 @li @ref evas_main_intro
15 @li @ref evas_main_work 9 @li @ref evas_main_work
16 @li @ref evas_main_compiling 10 @li @ref evas_main_compiling
17 @li @ref evas_main_install
18 @li @ref evas_main_next_steps 11 @li @ref evas_main_next_steps
19 @li @ref evas_main_intro_example 12 @li @ref evas_main_intro_example
20 13
21 14
22 @section evas_main_intro What is Evas? 15 @section evas_main_intro Introduction
23 16
24 Evas is a clean display canvas API for several target display systems 17 Evas is a clean display canvas API for several target display systems
25 that can draw anti-aliased text, smooth super and sub-sampled scaled 18 that can draw anti-aliased text, smooth super and sub-sampled scaled
@@ -46,7 +39,7 @@
46 39
47 Evas is not a widget set or widget toolkit, however it is their 40 Evas is not a widget set or widget toolkit, however it is their
48 base. See Elementary (http://docs.enlightenment.org/auto/elementary/) 41 base. See Elementary (http://docs.enlightenment.org/auto/elementary/)
49 for a toolkit based on Evas, Edje, Ecore and other Enlightenment 42 for a toolkit based on Evas, Edje, @ref Ecore and other Enlightenment
50 technologies. 43 technologies.
51 44
52 It is not dependent or aware of main loops, input or output 45 It is not dependent or aware of main loops, input or output
@@ -54,8 +47,8 @@
54 Evas. Similarly, it will not create windows or report windows updates 47 Evas. Similarly, it will not create windows or report windows updates
55 to your system, rather just drawing the pixels and reporting to the 48 to your system, rather just drawing the pixels and reporting to the
56 user the areas that were changed. Of course these operations are quite 49 user the areas that were changed. Of course these operations are quite
57 common and thus they are ready to use in Ecore, particularly in 50 common and thus they are ready to use in @ref Ecore, particularly in
58 Ecore_Evas (http://docs.enlightenment.org/auto/ecore/). 51 @ref Ecore_Evas_Group.
59 52
60 53
61 @section evas_main_work How does Evas work? 54 @section evas_main_work How does Evas work?
@@ -184,7 +177,7 @@
184 scrollbars, sliders, push buttons etc. 177 scrollbars, sliders, push buttons etc.
185 178
186 179
187 @section evas_main_compiling How to compile using Evas ? 180 @section evas_main_compiling How to compile
188 181
189 Evas is a library your application links to. The procedure for this is 182 Evas is a library your application links to. The procedure for this is
190 very simple. You simply have to compile your application with the 183 very simple. You simply have to compile your application with the
@@ -203,42 +196,17 @@
203 gcc -o my_application main.o `pkg-config --libs evas` 196 gcc -o my_application main.o `pkg-config --libs evas`
204 @endverbatim 197 @endverbatim
205 198
206 You simply have to make sure that @c pkg-config is in your shell's @c 199 See @ref pkgconfig
207 PATH (see the manual page for your appropriate shell) and @c evas.pc
208 in @c /usr/lib/pkgconfig or its path in the @c PKG_CONFIG_PATH
209 environment variable. It's that simple to link and use Evas once you
210 have written your code to use it.
211
212 Since the program is linked to Evas, it is now able to use any
213 advertised API calls to display graphics in a canvas managed by it, as
214 well as use the API calls provided to manage data.
215
216 You should make sure you add any extra compile and link flags to your
217 compile commands that your application may need as well. The above
218 example is only guaranteed to make Evas add it's own requirements.
219
220
221 @section evas_main_install How is it installed?
222
223 Simple:
224
225 @verbatim
226 ./configure
227 make
228 su -
229 ...
230 make install
231 @endverbatim
232 200
233 @section evas_main_next_steps Next Steps 201 @section evas_main_next_steps Next Steps
234 202
235 After you understood what Evas is and installed it in your system you 203 After you understood what Evas is and installed it in your system
236 should proceed understanding the programming interface for all 204 you should proceed understanding the programming interface for all
237 objects, then see the specific for the most used elements. We'd 205 objects, then see the specific for the most used elements. We'd
238 recommend you to take a while to learn Ecore 206 recommend you to take a while to learn @ref Ecore, Edje
239 (http://docs.enlightenment.org/auto/ecore/) and Edje 207 (http://docs.enlightenment.org/auto/edje/) and Elementary
240 (http://docs.enlightenment.org/auto/edje/) as they will likely save 208 (http://docs.enlightenment.org/auto/elementary/) as they will
241 you tons of work compared to using just Evas directly. 209 likely save you tons of work compared to using just Evas directly.
242 210
243 Recommended reading: 211 Recommended reading:
244 212
@@ -268,6 +236,9 @@
268 @section evas_main_intro_example Introductory Example 236 @section evas_main_intro_example Introductory Example
269 237
270 @include evas-buffer-simple.c 238 @include evas-buffer-simple.c
239
240 More examples can be found at @ref evas_examples.
241
271 */ 242 */
272 243
273#ifndef _EVAS_H 244#ifndef _EVAS_H