summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGustavo Sverzut Barbieri <barbieri@gmail.com>2013-01-04 02:51:43 +0000
committerGustavo Sverzut Barbieri <barbieri@gmail.com>2013-01-04 02:51:43 +0000
commitc96a620b46bd19b0ed222d3aff4110b5f5af49db (patch)
treeb4aa04a13bb25e52af7a00f829c8ad5872ee248a
parent9ea2ce1041549c90f94062ce5ec145056e7fbdfa (diff)
efl/edje: improve docs after merge.
SVN revision: 82142
-rw-r--r--doc/Doxyfile.in24
-rw-r--r--doc/e.css34
-rw-r--r--doc/edje_examples.dox2
-rw-r--r--doc/main.dox39
-rw-r--r--src/lib/edje/Edje.h180
5 files changed, 154 insertions, 125 deletions
diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in
index 775d41f..243f8d4 100644
--- a/doc/Doxyfile.in
+++ b/doc/Doxyfile.in
@@ -603,7 +603,8 @@ INPUT = @top_srcdir@/src/lib \
603 @srcdir@/eio_examples.dox \ 603 @srcdir@/eio_examples.dox \
604 @srcdir@/edbus_examples.dox \ 604 @srcdir@/edbus_examples.dox \
605 @srcdir@/ephysics_examples.dox \ 605 @srcdir@/ephysics_examples.dox \
606 @srcdir@/edje_examples.dox 606 @srcdir@/edje_examples.dox \
607 @top_srcdir@/src/bin/edje/edje_cc_handlers.c
607 608
608# This tag can be used to specify the character encoding of the source files 609# This tag can be used to specify the character encoding of the source files
609# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is 610# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
@@ -1696,3 +1697,24 @@ GENERATE_LEGEND = YES
1696# the various graphs. 1697# the various graphs.
1697 1698
1698DOT_CLEANUP = YES 1699DOT_CLEANUP = YES
1700
1701# Aliases used by edcref
1702ALIASES = block="<tr><td class=\"block\"><b>"
1703ALIASES += context="</b></td><td class=\"context\" colspan=2>\code"
1704ALIASES += description="\endcode</td></tr><tr><td>&nbsp;</td><td class=\"description\" colspan=2>"
1705ALIASES += endblock="</td></tr>"
1706ALIASES += property="<tr><td>&nbsp;</td><td><table class=\"edcref\" border=\"0\"><tr><td class=\"property\"><tt>"
1707ALIASES += parameters="</tt></td><td class=\"parameters\"><tt>"
1708ALIASES += effect="</tt></td></tr><tr><td>&nbsp;</td><td class=\"effect\">"
1709ALIASES += endproperty="</td></tr></table></td></tr>"
1710ALIASES += edcsection{2}="<tr class=\"section\"><td class=\"section\" colspan=\"2\">\anchor sec_\1 \ref sec_quickaccess \"\2\"</td></tr>"
1711ALIASES += edcsubsection{2}="<tr class=\"subsection\"><td class=\"subsection\" colspan=\"2\">\anchor sec_\1 \ref sec_quickaccess \"\2\"</td></tr>"
1712
1713# Aliases used by luaref
1714ALIASES += luaclass{2}="\anchor \1 \n<div class=\"luaclass\">\2</div>"
1715ALIASES += attributes="<div class=\"luaattrib\">Attributes:</div>"
1716ALIASES += methods="<div class=\"luaattrib\">Methods:</div>"
1717ALIASES += events="<div class=\"luaattrib\">Events:</div>"
1718ALIASES += setters="<div class=\"luaattrib\">Setters:</div>"
1719ALIASES += seealso{2}="<b>See also:</b> <a href='\2'>\1</a>\n"
1720ALIASES += seealso{1}="<b>See also:</b> \1\n"
diff --git a/doc/e.css b/doc/e.css
index 2dd6b44..2418ac9 100644
--- a/doc/e.css
+++ b/doc/e.css
@@ -271,3 +271,37 @@ td.nav_active {
271 width: 100%; 271 width: 100%;
272} 272}
273 273
274table.edcref tr td.block {
275 vertical-align: top;
276 padding-top: 10px;
277}
278
279table.edcref tr.section td.section, div.luaclass {
280 color: #888;
281 font-size: 16pt;
282 padding: 15px;
283 border-top: 1px solid #ccc;
284 text-align: center;
285}
286
287table.edcref tr.section td.section a {
288 color: #888;
289 text-decoration: none;
290}
291
292table.edcref tr.subsection td.subsection, div.luaclass {
293 color: #888;
294 font-size: 11pt;
295 padding: 1px;
296 text-align: center;
297}
298
299table.edcref tr.subsection td.subsection a {
300 color: #888;
301 text-decoration: none;
302}
303
304div.luaattrib {
305 color: #888;
306 border: 1px solid #ccc;
307}
diff --git a/doc/edje_examples.dox b/doc/edje_examples.dox
index a48ad7e..f44e0fa 100644
--- a/doc/edje_examples.dox
+++ b/doc/edje_examples.dox
@@ -1,5 +1,5 @@
1/** 1/**
2 * @page edje_examples Examples 2 * @page edje_examples Edje Examples
3 * 3 *
4 * Examples: 4 * Examples:
5 * @li @ref Example_Edje_Basics 5 * @li @ref Example_Edje_Basics
diff --git a/doc/main.dox b/doc/main.dox
index 7af5310..b69d1c1 100644
--- a/doc/main.dox
+++ b/doc/main.dox
@@ -20,6 +20,7 @@
20 * @li @ref efreet_main freedesktop.org (xdg) menu and desktop integration. 20 * @li @ref efreet_main freedesktop.org (xdg) menu and desktop integration.
21 * @li @ref eeze_main hardware device manipulation and notification. 21 * @li @ref eeze_main hardware device manipulation and notification.
22 * @li @ref ephysics_main physics simulation integration and visual effects. 22 * @li @ref ephysics_main physics simulation integration and visual effects.
23 * @li @ref edje_main layout and theme library with super powers.
23 * 24 *
24 */ 25 */
25 26
@@ -27,33 +28,44 @@
27 * @page authors Authors 28 * @page authors Authors
28 * 29 *
29 * @author Adam Simpkins <adam@@adamsimpkins.net> 30 * @author Adam Simpkins <adam@@adamsimpkins.net>
31 * @author Aharon Hillel <a.hillel@@partner.samsung.com>
30 * @author Albin "Lutin" Tonnerre <albin.tonnerre@@gmail.com> 32 * @author Albin "Lutin" Tonnerre <albin.tonnerre@@gmail.com>
31 * @author Andre Dieb <andre.dieb@@gmail.com> 33 * @author Andre Dieb <andre.dieb@@gmail.com>
32 * @author Andrew Elcock <andy@@elcock.org> 34 * @author Andrew Elcock <andy@@elcock.org>
33 * @author Arnaud de Turckheim 'quarium' <quarium@@gmail.com> 35 * @author Arnaud de Turckheim 'quarium' <quarium@@gmail.com>
34 * @author Bernhard Nemec <Bernhard.Nemec@@viasyshc.com> 36 * @author Bernhard Nemec <Bernhard.Nemec@@viasyshc.com>
37 * @author billiob (Boris Faure) <billiob@@gmail.com>
35 * @author Bluezery <ohpowel@@gmail.com> 38 * @author Bluezery <ohpowel@@gmail.com>
36 * @author Boris "billiob" Faure <billiob@@gmail.com> 39 * @author Boris "billiob" Faure <billiob@@gmail.com>
37 * @author Brett Nash <nash@@nash.id.au> 40 * @author Brett Nash <nash@@nash.id.au>
38 * @author Brian 'rephorm' Mattern <rephorm@@rephorm.com> 41 * @author Brian 'rephorm' Mattern <rephorm@@rephorm.com>
42 * @author Brian Mattern <rephorm@@rephorm.com>
39 * @author Bruno Dilly <bdilly@@profusion.mobi> 43 * @author Bruno Dilly <bdilly@@profusion.mobi>
40 * @author Burra <burra@@colorado.edu> 44 * @author Burra <burra@@colorado.edu>
41 * @author Carsten Haitzler <raster@@@rasterman.com> 45 * @author Carsten Haitzler <raster@@@rasterman.com>
42 * @author Cedric Bail <cedric.bail@@free.fr> 46 * @author Cedric BAIL <cedric.bail@@free.fr>
43 * @author Chidambar Zinnoury <illogict@@online.fr> 47 * @author Chidambar Zinnoury <illogict@@online.fr>
44 * @author Chris Ross <chris@@darkrock.co.uk> 48 * @author Chris Ross <chris@@darkrock.co.uk>
45 * @author Christophe Dumez <christophe.dumez@@intel.com> 49 * @author Christophe Dumez <christophe.dumez@@intel.com>
46 * @author Christopher 'devilhorns' Michael <cpmichael1@comcast.net> 50 * @author Christopher 'devilhorns' Michael <cpmichael1@comcast.net>
47 * @author ChunEon Park <hermet@@hermet.pe.kr> 51 * @author ChunEon Park (Hermet) <hermet@@hermet.pe.kr>
48 * @author Corey "atmos" Donohoe <atmos@@atmos.org> 52 * @author Corey "atmos" Donohoe <atmos@@atmos.org>
49 * @author dan sinclair <zero@@everburning.com> 53 * @author dan sinclair <zero@@everburning.com>
50 * @author Daniel Juyung Seo <seojuyung2@gmail.com> <juyung.seo@@samsung.com> 54 * @author Daniel Juyung Seo <seojuyung2@gmail.com> <juyung.seo@@samsung.com>
51 * @author Daniel Willmann <daniel@@totalueberwachung.de> 55 * @author Daniel Willmann <d.willmann@@samsung.com>
56 * @author Daniel Zaoui <daniel.zaoui@@yahoo.com>
52 * @author David 'onefang' Seikel <onefang@@gmail.com> 57 * @author David 'onefang' Seikel <onefang@@gmail.com>
53 * @author David Goodlad <dgoodlad@@gmail.com> 58 * @author David Goodlad <dgoodlad@@gmail.com>
59 * @author David Seikel <onefang at gmail.com>
60 * @author Davide Andreoli <dave@@gurumeditation.it>
54 * @author Doyoun Kang <wayofmine@@gmail.com> <doyoun.kang@@samsung.com> 61 * @author Doyoun Kang <wayofmine@@gmail.com> <doyoun.kang@@samsung.com>
62 * @author Fabiano Fidêncio <fidencio@@profusion.mobi>
63 * @author Flavio Ceolin <flavio.ceolin@@profusion.mobi>
64 * @author Govindaraju SM <govi.sm@@samsung.com> <govism@@gmail.com>
65 * @author Guilherme Silveira <xguiga@@gmail.com>
55 * @author Guillaume Friloux <guillaume.friloux@@asp64.com> 66 * @author Guillaume Friloux <guillaume.friloux@@asp64.com>
56 * @author Gustavo Chaves <glima@@profusion.mobi> 67 * @author Gustavo Chaves <glima@@profusion.mobi>
68 * @author Gustavo Lima Chaves <glima@@profusion.mobi>
57 * @author Gustavo Sverzut Barbieri <barbieri@@profusion.mobi> 69 * @author Gustavo Sverzut Barbieri <barbieri@@profusion.mobi>
58 * @author Gwanglim Lee <gl77.lee@@samsung.com> <gwanglim@@gmail.com> 70 * @author Gwanglim Lee <gl77.lee@@samsung.com> <gwanglim@@gmail.com>
59 * @author Haifeng Deng <haifeng.deng@@samsung.com> 71 * @author Haifeng Deng <haifeng.deng@@samsung.com>
@@ -62,12 +74,14 @@
62 * @author Hyoyoung Chang <hyoyoung@@gmail.com> 74 * @author Hyoyoung Chang <hyoyoung@@gmail.com>
63 * @author Ibukun Olumuyiwa <ibukun@@computer.org> 75 * @author Ibukun Olumuyiwa <ibukun@@computer.org>
64 * @author Iván Briano <ivan@@profusion.mobi> 76 * @author Iván Briano <ivan@@profusion.mobi>
77 * @author Jaehwan Kim <jae.hwan.kim@@samsung.com>
65 * @author Jihoon Kim <jihoon48.kim@@samsung.com> <imfine98@gmail.com> 78 * @author Jihoon Kim <jihoon48.kim@@samsung.com> <imfine98@gmail.com>
66 * @author Jorge Luis Zapata Muga <jorgeluis.zapata@@gmail.com> 79 * @author Jorge Luis Zapata Muga <jorgeluis.zapata@@gmail.com>
67 * @author Jose O Gonzalez <jose_ogp@@juno.com> 80 * @author Jose O Gonzalez <jose_ogp@@juno.com>
68 * @author José Roberto de Souza <zehortigoza@@profusion.mobi> 81 * @author José Roberto de Souza <zehortigoza@@profusion.mobi>
69 * @author Jérémy Zurcher <jeremy@@asynk.ch> 82 * @author Jérémy Zurcher <jeremy@@asynk.ch>
70 * @author Jérôme Pinot <ngc891@gmail.com> 83 * @author Jérôme Pinot <ngc891@@gmail.com>
84 * @author Kim Shinwoo <kimcinoo.efl@@gmail.com>
71 * @author Kim Woelders <kim@@woelders.dk> 85 * @author Kim Woelders <kim@@woelders.dk>
72 * @author Kim Yunhan <spbear@@gmail.com> 86 * @author Kim Yunhan <spbear@@gmail.com>
73 * @author Lars Munch <lars@@segv.dk> 87 * @author Lars Munch <lars@@segv.dk>
@@ -79,8 +93,9 @@
79 * @author Mathieu Taillefumier <mathieu.taillefumier@@free.fr> 93 * @author Mathieu Taillefumier <mathieu.taillefumier@@free.fr>
80 * @author Matt Barclay <mbarclay@@gmail.com> 94 * @author Matt Barclay <mbarclay@@gmail.com>
81 * @author Michael 'Mickey' Lauer <mickey@@tm.informatik.uni-frankfurt.de> 95 * @author Michael 'Mickey' Lauer <mickey@@tm.informatik.uni-frankfurt.de>
96 * @author Michael Bouchaud (yoz) <michael.bouchaud@@gmail.com>
82 * @author Mikael Sans <sans.mikael@@gmail.com> 97 * @author Mikael Sans <sans.mikael@@gmail.com>
83 * @author Mike Blumenkrantz <michael.blumenkrantz@@gmail.com> 98 * @author Mike Blumenkrantz <michael.blumenkrantz@@gmail.com
84 * @author Mike McCormack <mj.mccormack@@samsung.com> 99 * @author Mike McCormack <mj.mccormack@@samsung.com>
85 * @author Myoungwoon Roy Kim(roy_kim) <myoungwoon.kim@@samsung.com> <myoungwoon@@gmail.com> 100 * @author Myoungwoon Roy Kim(roy_kim) <myoungwoon.kim@@samsung.com> <myoungwoon@@gmail.com>
86 * @author Myungjae Lee <mjae.lee@@samsung.com> 101 * @author Myungjae Lee <mjae.lee@@samsung.com>
@@ -90,10 +105,13 @@
90 * @author Nicolas Aguirre <aguirre.nicolas@@gmail.com> 105 * @author Nicolas Aguirre <aguirre.nicolas@@gmail.com>
91 * @author Peter Wehrfritz <peter.wehrfritz@@web.de> 106 * @author Peter Wehrfritz <peter.wehrfritz@@web.de>
92 * @author PnB <Poor.NewBie@@gmail.com> 107 * @author PnB <Poor.NewBie@@gmail.com>
108 * @author Prince Kumar Dubey <prince.dubey@@samsung.com> <prince.dubey@@gmail.com>
93 * @author Rafael Antognolli <antognolli@@profusion.mobi> 109 * @author Rafael Antognolli <antognolli@@profusion.mobi>
94 * @author Rafal Krypa <r.krypa@@samsung.com> 110 * @author Rafal Krypa <r.krypa@@samsung.com>
111 * @author Rajeev Ranjan (Rajeev) <rajeev.r@@samsung.com> <rajeev.jnnce@@gmail.com>
95 * @author Raphael Kubo da Costa <kubo@@profusion.mobi> 112 * @author Raphael Kubo da Costa <kubo@@profusion.mobi>
96 * @author Ricardo de Almeida Gonzaga <ricardo@@profusion.mobi> 113 * @author Ricardo de Almeida Gonzaga <ricardo@@profusion.mobi>
114 * @author Robert David <robert.david.public@@gmail.com>
97 * @author Rui Miguel Silva Seabra <rms@@1407.org> 115 * @author Rui Miguel Silva Seabra <rms@@1407.org>
98 * @author Samsung Electronics 116 * @author Samsung Electronics
99 * @author Samsung SAIT 117 * @author Samsung SAIT
@@ -106,19 +124,22 @@
106 * @author Sung W. Park <sungwoo@@gmail.com> 124 * @author Sung W. Park <sungwoo@@gmail.com>
107 * @author Term <term@@twistedpath.org> 125 * @author Term <term@@twistedpath.org>
108 * @author Thierry el Borgi <thierry@@substantiel.fr> 126 * @author Thierry el Borgi <thierry@@substantiel.fr>
127 * @author Tiago Falcão <tiago@@profusion.mobi>
109 * @author Till Adam <till@@adam-lilienthal.de> 128 * @author Till Adam <till@@adam-lilienthal.de>
110 * @author Tilman Sauerbeck <tilman@@code-monkey.de> 129 * @author Tilman Sauerbeck <tilman@@code-monkey.de>
111 * @author Tim Horton <hortont424@gmail.com> 130 * @author Tim Horton <hortont424@gmail.com>
112 * @author Tom Gilbert <tom@@linuxbrit.co.uk> 131 * @author Tom Gilbert <tom@@linuxbrit.co.uk>
113 * @author Tom Hacohen <tom@@stosb.com> 132 * @author Tom Hacohen <tom@@stosb.com>
133 * @author Tristan <blunderer@@gmail.com>
114 * @author Vikram Narayanan <vikram186@gmail.com> 134 * @author Vikram Narayanan <vikram186@gmail.com>
115 * @author Vincent Torri <vincent.torri@@gmail.com> 135 * @author Vincent Torri <vincent.torri@@gmail.com>
116 * @author Vincent Torri <vtorri@@univ-evry.fr>
117 * @author Willem Monsuwe <willem@@stack.nl> 136 * @author Willem Monsuwe <willem@@stack.nl>
137 * @author WooHyun Jung (woohyun) <woohyun0705@@gmail.com>
118 * @author xlopez@@igalia.com 138 * @author xlopez@@igalia.com
119 * @author Youness Alaoui <kakaroto@@kakaroto.homelinux.net> 139 * @author Youness Alaoui <kakaroto@@kakaroto.homelinux.net>
120 * @author Yuri <da2001@hotmail.ru> 140 * @author Yuri <da2001@hotmail.ru>
121 * @author Yuri Hudobin <glassy_ape@@users.sourceforge.net> 141 * @author Yuri Hudobin <glassy_ape@@users.sourceforge.net>
142 * @author ZigsMcKenzie <zigsmckenzie@@gmail.com>
122 * 143 *
123 * Please contact <enlightenment-devel@@lists.sourceforge.net> to get in 144 * Please contact <enlightenment-devel@@lists.sourceforge.net> to get in
124 * contact with the developers and maintainers. 145 * contact with the developers and maintainers.
@@ -196,3 +217,9 @@
196 * 217 *
197 * @brief Hardware device manipulation and notification, wraps UDev and similar. 218 * @brief Hardware device manipulation and notification, wraps UDev and similar.
198 */ 219 */
220
221/**
222 * @defgroup Edje
223 *
224 * @brief Layout and theme library with super-powers.
225 */
diff --git a/src/lib/edje/Edje.h b/src/lib/edje/Edje.h
index 4d51404..c8b83a3 100644
--- a/src/lib/edje/Edje.h
+++ b/src/lib/edje/Edje.h
@@ -3,13 +3,19 @@
3 3
4These routines are used for Edje. 4These routines are used for Edje.
5 5
6@mainpage Edje Library Documentation 6@page edje_main Edje
7@version 1.7
8@date 2003-2012
9 7
10Please see the @ref authors page for contact details. 8@date 2003 (created)
11 9
12@section intro What is Edje? 10@section toc Table of Contents
11
12@li @ref edje_main_intro
13@li @ref edje_main_work
14@li @ref edje_main_compiling
15@li @ref edje_main_next_steps
16@li @ref edje_main_intro_example
17
18@section edje_main_intro Introduction
13 19
14Edje is a complex graphical design & layout library. 20Edje is a complex graphical design & layout library.
15 21
@@ -45,54 +51,9 @@ almost any look and feel one could want for basic visual elements. Anything
45more complex is likely the domain of an application or widget set that may 51more complex is likely the domain of an application or widget set that may
46use Edje as a convenient way of being able to configure parts of the display. 52use Edje as a convenient way of being able to configure parts of the display.
47 53
48For details of Edje's history, see the \ref history section. 54For details of Edje's history, see the @ref edje_history section.
49
50
51@section requirements What does Edje require?
52
53Edje requires fairly little on your system. to use the Edje runtime library
54you need:
55
56 - Evas (library)
57 - Ecore (library)
58 - Eet (library)
59 - Embryo (library)
60 - Eina (library)
61 - Lua 5.1 (library)
62
63Evas needs to be build with the JPEG, PNG and EET image loaders enabled at a
64minimum. You will also need the buffer engine (which requires the
65software_generic engine) as well.
66 55
67Ecore (library) needs the ECORE and ECORE_EVAS modules built at a minimum. 56@subsection edje_main_work So how does this all work?
68It's suggested to build all the Ecore modules. You will beed the Buffer
69engine support built into Ecore_Evas for edje_cc to function.
70
71
72@section compiling How to compile and test Edje
73
74Now you need to compile and install Edje.
75
76@verbatim
77 ./configure
78 make
79 sudo make install
80@endverbatim
81
82You now have it installed and ready to go, but you need input
83data. There are lots of examples in SVN, the best one is
84Enlightenment's own theme file.
85
86You may use different tools to edit and view the generated ".edj"
87files, for instance:
88
89 - edje_player (provided by Edje)
90 - edje_codegen (provided by Edje) @since 1.8.0
91 - editje (http://trac.enlightenment.org/e/wiki/Editje)
92 - edje_viewer (http://trac.enlightenment.org/e/wiki/Edje_Viewer)
93
94
95@section details So how does this all work?
96 57
97Edje internally holds a geometry state machine and state graph of what is 58Edje internally holds a geometry state machine and state graph of what is
98visible, not, where, at what size, with what colors etc. This is described 59visible, not, where, at what size, with what colors etc. This is described
@@ -105,20 +66,7 @@ The application using Edje will then create an object in its Evas
105canvas and set the bundle file to use, specifying the @b group name to 66canvas and set the bundle file to use, specifying the @b group name to
106use. Edje will load such information and create all the required 67use. Edje will load such information and create all the required
107children objects with the specified properties as defined in each @b 68children objects with the specified properties as defined in each @b
108part of the given group. See the following example: 69part of the given group. See the example at @ref edje_main_intro_example.
109@include edje_example.c
110
111The above example requires the following annotated source Edje file:
112@include edje_example.edc
113
114
115One should save these files as edje_example.c and edje_example.edc then:
116@verbatim
117gcc -o edje_example edje_example.c `pkg-config --cflags --libs eina evas ecore ecore-evas edje`
118edje_cc edje_example.edc
119
120./edje_example "some text"
121@endverbatim
122 70
123Although simple, this example illustrates that animations and state 71Although simple, this example illustrates that animations and state
124changes can be done from the Edje file itself without any requirement 72changes can be done from the Edje file itself without any requirement
@@ -127,8 +75,7 @@ in the C application.
127Before digging into changing or creating your own Edje source (edc) 75Before digging into changing or creating your own Edje source (edc)
128files, read the @ref edcref. 76files, read the @ref edcref.
129 77
130 78@subsection edje_history Edje History
131@section history Edje History
132 79
133It's a sequel to "Ebits" which has serviced the needs of Enlightenment 80It's a sequel to "Ebits" which has serviced the needs of Enlightenment
134development for early version 0.17. The original design parameters under 81development for early version 0.17. The original design parameters under
@@ -148,62 +95,58 @@ basic GUI constructor.
148 95
149Unlike Ebits, Edje separates the layout and behavior logic. 96Unlike Ebits, Edje separates the layout and behavior logic.
150 97
98@section edje_main_compiling How to compile
99
100Edje is a library your application links to. The procedure for this is
101very simple. You simply have to compile your application with the
102appropriate compiler flags that the @c pkg-config script outputs. For
103example:
104
105Compiling C or C++ files into object files:
106
107@verbatim
108gcc -c -o main.o main.c `pkg-config --cflags edje`
109@endverbatim
110
111Linking object files into a binary executable:
112
113@verbatim
114gcc -o my_application main.o `pkg-config --libs edje`
115@endverbatim
116
117See @ref pkgconfig
118
119@section edje_main_next_steps Next Steps
120
121After you understood what Edje is and installed it in your system you
122should proceed understanding the programming interface for all
123objects, then see the specific for the most used elements. We'd
124recommend you to take a while to learn @ref Ecore, @ref Evas, @ref Eo
125and @ref Eina as they are the building blocks for Edje. There is a
126widget set built on top of Edje providing high level elements such as
127buttons, lists and selectors called Elementary
128(http://docs.enlightenment.org/auto/elementary/) as they will likely
129save you tons of work compared to using just Evas directly.
151 130
152@section Edje_Examples Examples on Edje's usage 131Recommended reading:
132@li @ref edcref
133@li @ref Edje_General_Group
134@li @ref Edje_Object_Group
135@li @ref Edje_External_Group
136
137@section edje_main_intro_example Introductory Example
153 138
154What follows is a list with various commented examples, covering a great 139What follows is a list with various commented examples, covering a great
155part of Edje's API: 140part of Edje's API:
156 141
157@note The example files are located at /Where/Enlightenment/is/installed/share/edje/examples 142@include edje_example.c
158 143
159- @ref Example_Edje_Basics 144The above example requires the following annotated source Edje file:
160- @ref tutorial_edje_basic2 145@include edje_example.edc
161- @ref tutorial_edje_swallow
162- @ref tutorial_edje_swallow2
163- @ref tutorial_edje_table
164- @ref tutorial_edje_box
165- @ref tutorial_edje_box2
166- @ref tutorial_edje_color_class
167- @ref tutorial_edje_animations
168- @ref tutorial_edje_animations_2
169- @ref Example_Edje_Signals_Messages
170- @ref tutorial_edje_signals_2
171- @ref tutorial_edje_text
172- @ref tutorial_edje_drag
173- @ref tutorial_edje_perspective
174*/
175 146
176/**
177@page authors Authors
178@author Carsten Haitzler <raster@@rasterman.com>
179@author Tilman Sauerbeck (tilman at code-monkey de)
180@author ZigsMcKenzie <zigsmckenzie@@gmail.com>
181@author Cedric BAIL <cedric.bail@@free.fr>
182@author Brian Mattern <rephorm@@rephorm.com>
183@author Mathieu Taillefumier <mathieu.taillefumier@@free.fr>
184@author Tristan <blunderer@@gmail.com>
185@author Gustavo Lima Chaves <glima@@profusion.mobi>
186@author Bruno Dilly <bdilly@@profusion.mobi>
187@author Fabiano Fidêncio <fidencio@@profusion.mobi>
188@author Jihoon Kim <jihoon48.kim@@samsung.com>
189@author Tiago Falcão <tiago@@profusion.mobi>
190@author Davide Andreoli <dave@@gurumeditation.it>
191@author Sebastian Dransfeld <sd@@tango.flipp.net>
192@author Tom Hacohen <tom@@stosb.com>
193@author Aharon Hillel <a.hillel@@samsung.com>
194@author Shilpa Singh <shilpa.singh@samsung.com> <shilpasingh.o@gmail.com>
195@author Mike Blumenkrantz <michael.blumenkrantz@gmail.com
196@author Jaehwan Kim <jae.hwan.kim@samsung.com>
197@author billiob (Boris Faure) <billiob@gmail.com>
198@author Govindaraju SM <govi.sm@samsung.com> <govism@gmail.com>
199@author Prince Kumar Dubey <prince.dubey@samsung.com> <prince.dubey@gmail.com>
200@author David Seikel <onefang at gmail.com>
201@author Guilherme Íscaro <iscaro@profusion.mobi>
202
203Please contact <enlightenment-devel@lists.sourceforge.net> to get in
204contact with the developers and maintainers.
205*/
206 147
148More examples can be found at @ref edje_examples.
149*/
207 150
208/** 151/**
209 152
@@ -260,6 +203,7 @@ param in edje programs
260 203
261/** 204/**
262 * @defgroup Edje_General_Group Edje General 205 * @defgroup Edje_General_Group Edje General
206 * @ingroup Edje
263 * 207 *
264 * @brief This group discusses functions that have general purposes or affect Edje as a whole. 208 * @brief This group discusses functions that have general purposes or affect Edje as a whole.
265 * 209 *
@@ -524,6 +468,7 @@ EAPI void edje_collection_cache_flush (void);
524 468
525/** 469/**
526 * @defgroup Edje_External_Group Edje External 470 * @defgroup Edje_External_Group Edje External
471 * @ingroup Edje
527 * 472 *
528 * @brief This group discusses functions of the external section of Edje. 473 * @brief This group discusses functions of the external section of Edje.
529 * 474 *
@@ -3253,6 +3198,7 @@ EAPI const Edje_External_Type *edje_external_type_get (const char
3253 3198
3254/** 3199/**
3255 * @defgroup Edje_Object_Group Edje Object 3200 * @defgroup Edje_Object_Group Edje Object
3201 * @ingroup Edje
3256 * 3202 *
3257 * @brief This group discusses functions that deal with Edje layouts and its components 3203 * @brief This group discusses functions that deal with Edje layouts and its components
3258 * 3204 *