summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorStefan Schmidt <stefan@osg.samsung.com>2016-04-13 15:06:52 +0200
committerStefan Schmidt <stefan@osg.samsung.com>2016-04-13 17:01:23 +0200
commita1663b171022819643a598978c9665454f80fc71 (patch)
tree2ec0ec852638ea8bde8e1d637d8e9cbe80ad9c61
parent74a046fee59c49f08a13e737c742f5dbcb26d563 (diff)
docs: make elementary docs available form main doc page
While elm docs have been merged in they never have been accessible from the main page of our docs. Fix this by including elm_intro.h and referencing it from the main page. While we are at it rename it to the scheme we used in EFL. Another missing piece was the index with all widget references. Never brought over form the elm legacy tree. Putting this in and we are now at least able to navigate to all elm widget pages.
-rw-r--r--doc/Doxyfile.in2
-rw-r--r--doc/index_elm.dox327
-rw-r--r--doc/main.dox1
-rw-r--r--elm_intro.h.in2
4 files changed, 331 insertions, 1 deletions
diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in
index f4e2e2f..50470a8 100644
--- a/doc/Doxyfile.in
+++ b/doc/Doxyfile.in
@@ -595,6 +595,8 @@ WARN_LOGFILE =
595 595
596INPUT = @top_srcdir@/src/lib \ 596INPUT = @top_srcdir@/src/lib \
597 @top_srcdir@/src/bindings \ 597 @top_srcdir@/src/bindings \
598 @top_srcdir@/elm_intro.h \
599 @srcdir@/index_elm.dox \
598 @srcdir@/main.dox \ 600 @srcdir@/main.dox \
599 @srcdir@/pkgconfig.dox \ 601 @srcdir@/pkgconfig.dox \
600 @srcdir@/eina_examples.dox \ 602 @srcdir@/eina_examples.dox \
diff --git a/doc/index_elm.dox b/doc/index_elm.dox
new file mode 100644
index 0000000..1ac6e76
--- /dev/null
+++ b/doc/index_elm.dox
@@ -0,0 +1,327 @@
1/**
2 * @page infralist Infrastructure list
3 *
4 * Elementary is mostly composed of widgets, but it also contains some
5 * infrastructure modules that facilitate the use of widgets. These are the
6 * infrastructure modules:
7 * @li @ref Elm_App
8 * @li @ref Elm_Caches
9 * @li @ref Elm_Cursors
10 * @li @ref Elm_Debug
11 * @li @ref Elm_Config
12 * @li @ref Elm_Engine
13 * @li @ref Elm_Fonts
14 * @li @ref Elm_Profile
15 * @li @ref Elm_Fingers
16 * @li @ref Elm_Focus
17 * @li @ref Elm_General
18 * @li @ref Elm_Gesture_Layer
19 * @li @ref Elm_Password_last_show
20 * @li @ref elm-prefs-data
21 * @li @ref Elm_Start
22 * @li @ref Elm_Scrolling
23 * @li @ref Elm_Scrollhints
24 * @li @ref Elm_Mirroring
25 * @li @ref Elm_Scaling
26 * @li @ref Elm_Styles
27 * @li @ref Elm_Theme
28 * @li @ref Elm_Transit
29 * @li @ref Elm_WidgetNavigation
30 *
31 * The other two main groups in Elementary are:
32 * @li @ref widgetslist - These are the widgets you'll compose your UI out of.
33 * @li @ref containerslist - These are the containers which hold the widgets.
34 *
35 * Also see other generic EFL programming guides:
36 * @li @ref threading
37 */
38/**
39 * @page widgetslist Widget list
40 *
41 * Here is a list of the widgets and some images to give you an idea of what
42 * they are:
43 * @li @ref Elm_Actionslider
44 *
45 * @image html img/widget/actionslider/preview-00.png
46 * @image latex img/widget/actionslider/preview-00.eps
47 * @li @ref Elm_Bg
48 *
49 * @image html img/widget/bg/preview-00.png
50 * @image latex img/widget/bg/preview-00.eps
51 * @li @ref Elm_Bubble
52 *
53 * @image html img/widget/bubble/preview-00.png
54 * @image latex img/widget/bubble/preview-00.eps
55 * @li @ref Elm_Button
56 *
57 * @image html img/widget/button/preview-00.png
58 * @image latex img/widget/button/preview-00.eps
59 * @li @ref Elm_Calendar
60 *
61 * @image html img/widget/calendar/preview-00.png
62 * @image latex img/widget/calendar/preview-00.eps
63 * @li @ref Elm_Check
64 *
65 * @image html img/widget/check/preview-00.png
66 * @image latex img/widget/check/preview-00.eps
67 * @li @ref Elm_Clock
68 *
69 * @image html img/widget/clock/preview-00.png
70 * @image latex img/widget/clock/preview-00.eps
71 *
72 * @li @ref Elm_Colorselector
73 *
74 * @image html img/widget/colorselector/preview-00.png
75 * @image latex img/widget/colorselector/preview-00.eps
76 * @li @ref Elm_Ctxpopup
77 *
78 * @image html img/widget/ctxpopup/preview-00.png
79 * @image latex img/widget/ctxpopup/preview-00.eps
80 * @li @ref Elm_Combobox
81 *
82 * @image html img/widget/combobox/preview-00.png
83 * @image latex img/widget/combobox/preview-00.eps
84 * @li @ref Elm_Datetime
85 *
86 * @image html img/widget/datetime/preview-00.png
87 * @image latex img/widget/datetime/preview-00.eps
88 * @li @ref Elm_Dayselector
89 *
90 * @image html img/widget/dayselector/preview-00.png
91 * @image latex img/widget/dayselector/preview-00.eps
92 * @li @ref Elm_Diskselector
93 *
94 * @image html img/widget/diskselector/preview-00.png
95 * @image latex img/widget/diskselector/preview-00.eps
96 * @li @ref Elm_Entry
97 *
98 * @image html img/widget/entry/preview-02.png
99 * @image latex img/widget/entry/preview-02.eps
100 * @li @ref Elm_File_Selector_Button
101 *
102 * @image html img/widget/fileselector_button/preview-00.png
103 * @image latex img/widget/fileselector_button/preview-00.eps
104 * @li @ref Elm_File_Selector_Entry
105 *
106 * @image html img/widget/fileselector_entry/preview-00.png
107 * @image latex img/widget/fileselector_entry/preview-00.eps
108 * @li @ref Elm_Fileselector
109 *
110 * @image html img/widget/fileselector/preview-00.png
111 * @image latex img/widget/fileselector/preview-00.eps
112 * @li @ref Elm_Flip
113 *
114 * @image html img/widget/flip/preview-00.png
115 * @image latex img/widget/flip/preview-00.eps
116 * @li @ref Elm_Flipselector
117 *
118 * @image html img/widget/flipselector/preview-00.png
119 * @image latex img/widget/flipselector/preview-00.eps
120 * @li @ref Elm_Frame
121 *
122 * @image html img/widget/frame/preview-00.png
123 * @image latex img/widget/frame/preview-00.eps
124 *
125 * @li @ref Elm_GLView
126 * @li @ref Elm_Hover
127 *
128 * @image html img/widget/hover/preview-00.png
129 * @image latex img/widget/hover/preview-00.eps
130 * @li @ref Elm_Hoversel
131 *
132 * @image html img/widget/hoversel/preview-00.png
133 * @image latex img/widget/hoversel/preview-00.eps
134 * @li @ref Elm_Icon
135 *
136 * @image html img/widget/icon/preview-00.png
137 * @image latex img/widget/icon/preview-00.eps
138 * @li @ref Elm_Image
139 *
140 * @image html img/widget/image/preview-00.png
141 * @image latex img/widget/image/preview-00.eps
142 * @li @ref Elm_Index
143 *
144 * @image html img/widget/index/preview-00.png
145 * @image latex img/widget/index/preview-00.eps
146 * @li @ref Elm_Inwin
147 *
148 * @image html img/widget/inwin/preview-00.png
149 * @image latex img/widget/inwin/preview-00.eps
150 * @li @ref Elm_List
151 *
152 * @image html img/widget/list/preview-00.png
153 * @image latex img/widget/list/preview-00.eps
154 * @image html img/list.png
155 * @image latex img/list.eps
156 * @li @ref Elm_Label
157 *
158 * @image html img/widget/label/preview-00.png
159 * @image latex img/widget/label/preview-00.eps
160 * @li @ref Elm_Map
161 *
162 * @image html img/widget/map/preview-00.png
163 * @image latex img/widget/map/preview-00.eps
164 * @li @ref Elm_Mapbuf
165 *
166 * @image html img/widget/mapbuf/preview-00.png
167 * @image latex img/widget/mapbuf/preview-00.eps
168 * @li @ref Elm_Menu
169 *
170 * @image html img/widget/menu/preview-00.png
171 * @image latex img/widget/menu/preview-00.eps
172 * @li @ref Elm_Notify
173 *
174 * @image html img/widget/notify/preview-00.png
175 * @image latex img/widget/notify/preview-00.eps
176 * @li @ref Elm_Panel
177 *
178 * @image html img/widget/panel/preview-00.png
179 * @image latex img/widget/panel/preview-00.eps
180 * @li @ref Elm_Photo
181 * @li @ref Elm_Photocam
182 *
183 * @image html img/widget/photocam/preview-00.png
184 * @image latex img/widget/photocam/preview-00.eps
185 * @li @ref Elm_Popup
186 *
187 * @li @ref Elm_Prefs
188 *
189 * @image html img/widget/prefs/preview-00.png
190 * @image latex img/widget/prefs/preview-00.eps
191 * @image html img/prefs.png
192 * @image latex img/prefs.eps
193 *
194 * @li @ref Elm_Progressbar
195 *
196 * @image html img/widget/progressbar/preview-00.png
197 * @image latex img/widget/progressbar/preview-00.eps
198 * @li @ref Elm_Radio
199 *
200 * @image html img/widget/radio/preview-00.png
201 * @image latex img/widget/radio/preview-00.eps
202 * @li @ref Elm_Route
203 * @li @ref Elm_SegmentControl
204 *
205 * @image html img/widget/segment_control/preview-00.png
206 * @image latex img/widget/segment_control/preview-00.eps
207 * @image html img/segment_control.png
208 * @image latex img/segment_control.eps
209 * @li @ref Elm_Separator
210 *
211 * @image html img/widget/separator/preview-00.png
212 * @image latex img/widget/separator/preview-00.eps
213 * @li @ref Elm_Slider
214 *
215 * @image html img/widget/slider/preview-00.png
216 * @image latex img/widget/slider/preview-00.eps
217 * @li @ref Elm_Slideshow
218 *
219 * @image html img/widget/slideshow/preview-00.png
220 * @image latex img/widget/slideshow/preview-00.eps
221 * @li @ref Elm_Spinner
222 *
223 * @image html img/widget/spinner/preview-00.png
224 * @image latex img/widget/spinner/preview-00.eps
225 * @li @ref Elm_Thumb
226
227 * @image html img/widget/thumb/preview-00.png
228 * @image latex img/widget/thumb/preview-00.eps
229 * @li @ref Elm_Toolbar
230 *
231 * @image html img/widget/toolbar/preview-00.png
232 * @image latex img/widget/toolbar/preview-00.eps
233 * @image html img/toolbar.png
234 * @image latex img/toolbar.eps
235 * @li @ref Elm_Tooltips
236 * @li @ref Elm_Video
237 * @li @ref Elm_Web
238 *
239 * @image html img/widget/web/preview-00.png
240 * @image latex img/widget/web/preview-00.eps
241 * @li @ref Elm_Win
242 *
243 * @image html img/widget/win/preview-00.png
244 * @image latex img/widget/win/preview-00.eps
245 *
246 * The other two main groups in Elementary are:
247 * @li @ref infralist - These are modules that deal with Elementary as a whole.
248 * @li @ref containerslist - These are the containers which will hold the widgets.
249 */
250/**
251 * @page containerslist Containers List
252 *
253 * Elementary is about displaying its widgets in a nice layout, for this purpose
254 * it provides a number of containers. It's important to note that as containers
255 * widgets don't have their own visual identity, so here we show one use for
256 * them and a diagram showing their component parts:
257 * @li @ref Elm_Gengrid
258 *
259 * @image html img/widget/gengrid/preview-00.png
260 * @image latex img/widget/gengrid/preview-00.eps
261 * @li @ref Elm_Genlist
262 *
263 * @image html img/widget/genlist/preview-00.png
264 * @image latex img/widget/genlist/preview-00.eps
265 * @image html img/genlist.png
266 * @image latex img/genlist.eps
267 * @li @ref Elm_Box
268 *
269 * @image html img/widget/box/preview-00.png
270 * @image latex img/widget/box/preview-00.eps
271 * @image html img/box.png
272 * @image latex img/box.eps
273 * @li @ref Elm_Conformant
274 *
275 * @image html img/widget/conformant/preview-00.png
276 * @image latex img/widget/conformant/preview-00.eps
277 * @image html img/conformant.png
278 * @image latex img/conformant.eps
279 * @li @ref Elm_Grid
280 * @li @ref Elm_Layout
281 *
282 * @image html img/widget/layout/preview-00.png
283 * @image latex img/widget/layout/preview-00.eps
284 * @image html img/layout-predefined.png
285 * @image latex img/layout-predefined.eps
286 *
287 * @li @ref Elm_Naviframe
288 *
289 * @li @ref Elm_Panes
290 *
291 * @image html img/widget/panes/preview-00.png
292 * @image latex img/widget/panes/preview-00.eps
293 * @image html img/panes.png
294 * @image latex img/panes.eps
295 * @li @ref Elm_Scroller
296 *
297 * @image html img/widget/scroller/preview-00.png
298 * @image latex img/widget/scroller/preview-00.eps
299 * @li @ref Elm_Table
300 *
301 * @image html img/widget/table/preview-00.png
302 * @image latex img/widget/table/preview-00.eps
303 *
304 * The other two main groups in Elementary are:
305 * @li @ref infralist - These are modules that deal with Elementary as a whole.
306 * @li @ref widgetslist - These are the widgets you'll compose your UI out of.
307 */
308/**
309 * @page threading Threading
310 *
311 * You may use threads with EFL, but only in specific ways. If you plan on
312 * using threads it is very important you see the following example guides.
313 * See the following
314 *
315 * @ref efl_thread_1
316 *
317 * @ref efl_thread_2
318 *
319 * @ref efl_thread_3
320 *
321 * @ref efl_thread_4
322 *
323 * @ref efl_thread_5
324 *
325 * @ref efl_thread_6
326 *
327 */
diff --git a/doc/main.dox b/doc/main.dox
index 5d62e2f..51a9e5e 100644
--- a/doc/main.dox
+++ b/doc/main.dox
@@ -25,6 +25,7 @@
25 * @li @ref eolian_main an EO file parser and code generator. 25 * @li @ref eolian_main an EO file parser and code generator.
26 * @li @ref eina_cxx_main Eina C++ bindings. 26 * @li @ref eina_cxx_main Eina C++ bindings.
27 * @li @ref elocation_main awareness library. 27 * @li @ref elocation_main awareness library.
28 * @li @ref elementary_main widget library.
28 * 29 *
29 */ 30 */
30 31
diff --git a/elm_intro.h.in b/elm_intro.h.in
index f19eff4..7394aaa 100644
--- a/elm_intro.h.in
+++ b/elm_intro.h.in
@@ -1,5 +1,5 @@
1/** 1/**
2 * @mainpage Elementary 2 * @page elementary_main
3 * @image html elementary.png 3 * @image html elementary.png
4 * @version @VMAJ@.@VMIN@.@VMIC@ 4 * @version @VMAJ@.@VMIN@.@VMIC@
5 * @date 2008-2014 5 * @date 2008-2014