summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorCedric BAIL <cedric@osg.samsung.com>2016-03-28 16:56:31 -0700
committerCedric BAIL <cedric@osg.samsung.com>2016-03-28 16:56:31 -0700
commitb6a81b6e7bbcc3991c6efc11d14802bc028d9365 (patch)
treefbe3c07c6e36d3b60f89dd5f483024497ab2b2ec /doc
parent5f178387112f9250bc57be252b1e4456a250a05a (diff)
elementary: start bringing back documentation support.
I didn't know preview generation was so slow and done completely serialy. There is potential improvement here. Still need to kind of merge the documentation into something readable.
Diffstat (limited to 'doc')
-rw-r--r--doc/.gitignore7
-rw-r--r--doc/Makefile.am185
-rw-r--r--doc/widgets/Makefile.am21
3 files changed, 205 insertions, 8 deletions
diff --git a/doc/.gitignore b/doc/.gitignore
new file mode 100644
index 0000000..199e7ee
--- /dev/null
+++ b/doc/.gitignore
@@ -0,0 +1,7 @@
1/elementary.dox
2/Doxyfile
3/widget_preview_*
4/widgets/widget_preview_*
5/html
6/man
7/latex
diff --git a/doc/Makefile.am b/doc/Makefile.am
index 2765bb1..9b89fb2 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -1,4 +1,4 @@
1SUBDIRS = previews 1SUBDIRS = previews widgets
2 2
3MAINTAINERCLEANFILES = Makefile.in 3MAINTAINERCLEANFILES = Makefile.in
4 4
@@ -16,8 +16,189 @@ previews-build:
16 16
17previews-data: 17previews-data:
18 @$(MAKE) -C previews doc 18 @$(MAKE) -C previews doc
19# dir:file name:executable:width:height
20WGT_PREVIEW = \
21 actionslider:preview-00.png:widget_preview_actionslider:120:30 \
22 bg:preview-00.png:widget_preview_bg:50:50 \
23 box:preview-00.png:widget_preview_box:200:160 \
24 bubble:preview-00.png:widget_preview_bubble1:160:50 \
25 bubble:preview-01.png:widget_preview_bubble2:160:50 \
26 bubble:preview-02.png:widget_preview_bubble3:160:50 \
27 button:preview-00.png:widget_preview_button1:160:50 \
28 button:preview-01.png:widget_preview_button2:160:50 \
29 button:preview-02.png:widget_preview_button3:160:50 \
30 calendar:preview-00.png:widget_preview_calendar:300:300 \
31 check:preview-00.png:widget_preview_check1:160:50 \
32 check:preview-01.png:widget_preview_check2:160:50 \
33 check:preview-02.png:widget_preview_check3:160:50 \
34 clock:preview-00.png:widget_preview_clock:200:100 \
35 colorselector:preview-00.png:widget_preview_colorselector:320:300 \
36 conformant:preview-00.png:widget_preview_conformant:200:400 \
37 combobox:preview-00.png:widget_preview_combobox:300:300 \
38 ctxpopup:preview-00.png:widget_preview_ctxpopup:200:130 \
39 datetime:preview-00.png:widget_preview_datetime1:360:60 \
40 datetime:preview-01.png:widget_preview_datetime2:200:60 \
41 datetime:preview-02.png:widget_preview_datetime3:200:60 \
42 dayselector:preview-00.png:widget_preview_dayselector:350:50 \
43 diskselector:preview-00.png:widget_preview_diskselector:120:50 \
44 entry:preview-00.png:widget_preview_entry1:160:50 \
45 entry:preview-01.png:widget_preview_entry2:160:50 \
46 entry:preview-02.png:widget_preview_entry3:160:50 \
47 entry:preview-03.png:widget_preview_entry4:160:50 \
48 fileselector:preview-00.png:widget_preview_fileselector:300:300 \
49 fileselector_button:preview-00.png:widget_preview_fileselector_button1:200:50 \
50 fileselector_button:preview-01.png:widget_preview_fileselector_button2:200:50 \
51 fileselector_button:preview-02.png:widget_preview_fileselector_button3:160:50 \
52 fileselector_entry:preview-00.png:widget_preview_fileselector_entry:70:50 \
53 flip:preview-00.png:widget_preview_flip:100:100 \
54 flipselector:preview-00.png:widget_preview_flipselector:100:60 \
55 frame:preview-00.png:widget_preview_frame:100:50 \
56 gengrid:preview-00.png:widget_preview_gengrid:200:160 \
57 genlist:preview-00.png:widget_preview_genlist1:200:200 \
58 genlist:preview-01.png:widget_preview_genlist2:200:160 \
59 genlist:preview-02.png:widget_preview_genlist3:200:160 \
60 genlist:preview-03.png:widget_preview_genlist4:200:160 \
61 genlist:preview-04.png:widget_preview_genlist5:200:160 \
62 hover:preview-00.png:widget_preview_hover:90:170 \
63 hoversel:preview-00.png:widget_preview_hoversel:90:170 \
64 icon:preview-00.png:widget_preview_icon:50:50 \
65 image:preview-00.png:widget_preview_image:50:50 \
66 index:preview-00.png:widget_preview_index:200:160 \
67 inwin:preview-00.png:widget_preview_inwin1:200:160 \
68 inwin:preview-01.png:widget_preview_inwin2:200:160 \
69 inwin:preview-02.png:widget_preview_inwin3:200:160 \
70 label:preview-00.png:widget_preview_label:70:30 \
71 layout:preview-00.png:widget_preview_layout:200:160 \
72 list:preview-00.png:widget_preview_list:200:200 \
73 map:preview-00.png:widget_preview_map:256:256 \
74 mapbuf:preview-00.png:widget_preview_mapbuf:200:200 \
75 menu:preview-00.png:widget_preview_menu:100:100 \
76 notify:preview-00.png:widget_preview_notify:60:30 \
77 panel:preview-00.png:widget_preview_panel:150:50 \
78 panes:preview-00.png:widget_preview_panes:200:100 \
79 photocam:preview-00.png:widget_preview_photocam:243:162 \
80 popup:preview-00.png:widget_preview_popup:480:400 \
81 prefs:preview-00.png:widget_preview_prefs:200:160 \
82 prefs:preview-00.png:widget_preview_prefs:280:250 \
83 progressbar:preview-00.png:widget_preview_progressbar:150:50 \
84 radio:preview-00.png:widget_preview_radio:60:20 \
85 scroller:preview-00.png:widget_preview_scroller:100:30 \
86 segment_control:preview-00.png:widget_preview_segment_control:240:120 \
87 separator:preview-00.png:widget_preview_separator:10:80 \
88 slider:preview-00.png:widget_preview_slider:200:100 \
89 slideshow:preview-00.png:widget_preview_slideshow:50:50 \
90 spinner:preview-00.png:widget_preview_spinner:160:30 \
91 table::preview-00.png:widget_preview_table:100:100 \
92 table:preview-00.png:widget_preview_table:100:100 \
93 thumb:preview-00.png:widget_preview_thumb:100:100 \
94 toolbar:preview-00.png:widget_preview_toolbar:300:100 \
95 web:preview-00.png:widget_preview_web:300:300 \
96 win:preview-00.png:widget_preview_win:200:200
19 97
20doc: all previews-build previews-data 98# put in here every elm widget, so that it gets its hierarchy tree built
99# then, make a reference to the generated image, in the form
100# @image html <WGTNAME>_inheritance_tree.{png,eps}
101WGT_TREE = \
102 actionslider \
103 bg \
104 box \
105 bubble \
106 button \
107 calendar \
108 check \
109 clock \
110 colorselector \
111 conformant \
112 container \
113 combobox \
114 ctxpopup \
115 datetime \
116 dayselector \
117 diskselector \
118 entry \
119 fileselector \
120 fileselector_button \
121 fileselector_entry \
122 flip \
123 flipselector \
124 frame \
125 gengrid \
126 genlist \
127 gesture_layer \
128 glview \
129 grid \
130 hover \
131 hoversel \
132 icon \
133 image \
134 index \
135 inwin \
136 label \
137 layout \
138 list \
139 map \
140 mapbuf \
141 menu \
142 multibuttonentry \
143 naviframe \
144 notify \
145 panel \
146 panes \
147 photo \
148 photocam \
149 player \
150 plug \
151 popup \
152 prefs \
153 progressbar \
154 radio \
155 route \
156 scroller \
157 segment_control \
158 separator \
159 slider \
160 slideshow \
161 spinner \
162 table \
163 thumb \
164 toolbar \
165 video \
166 web \
167 win
168
169widget-build:
170 @$(MAKE) -C widgets
171
172widget-preview: widget-build
173 @for ss in $(WGT_PREVIEW); do \
174 ENTRY=($${ss//:/ }) ; \
175 DIR=$${ENTRY[0]} ; \
176 SS=$${ENTRY[1]} ; \
177 BIN=$${ENTRY[2]} ; \
178 X=$${ENTRY[3]} ; \
179 Y=$${ENTRY[4]} ; \
180 echo "Generating widget preview image" $${SS} "for widget" $${DIR}; \
181 $(top_srcdir)/doc/shot.sh $(top_builddir)/doc/html/img/widget/$${DIR} $${SS} $(top_builddir)/doc/widgets/$${BIN} $${X} $${Y} ; \
182 mkdir -p $(top_builddir)/doc/latex/img/widget/$${DIR} ; \
183 convert $(top_builddir)/doc/html/img/widget/$${DIR}/$${SS} $(top_builddir)/doc/latex/img/widget/$${DIR}/$${SS/.png/.eps} ; \
184 done
185
186widget-tree-figures: doc
187 $(srcdir)/widget_hierarchy.py --scan $(top_srcdir)/src/lib -o $(builddir)/widget_tree.p;
188 $(srcdir)/widget_hierarchy.py --tree -i $(builddir)/widget_tree.p > $(builddir)/widgets_tree.dot;
189 dot -Tpng -o $(top_srcdir)/doc/img/elm-widget-tree.png $(top_builddir)/doc/widgets_tree.dot;
190 convert $(top_srcdir)/doc/img/elm-widget-tree.png $(top_srcdir)/doc/img/"elm-widget-tree.eps";
191 @for wgt in $(WGT_TREE); do \
192 WGT_FILE_NAME="WNAME_inheritance_tree.dot"; \
193 WGT_FILE_NAME=$${WGT_FILE_NAME/WNAME/$${wgt}}; \
194 echo "Generating widget inheritance tree image for widget" $${wgt}; \
195 $(srcdir)/widget_hierarchy.py --widget=$${wgt} -i $(top_builddir)/doc/widget_tree.p > $(top_builddir)/doc/$${WGT_FILE_NAME}; \
196 dot -Tpng -o $(top_srcdir)/doc/img/$${WGT_FILE_NAME/.dot/.png} $(top_builddir)/doc/$${WGT_FILE_NAME}; \
197 convert $(top_srcdir)/doc/img/$${WGT_FILE_NAME/.dot/.png} $(top_srcdir)/doc/img/$${WGT_FILE_NAME/.dot/.eps}; \
198 rm $${WGT_FILE_NAME}; \
199 done
200
201doc: all previews-build previews-data widget-preview
21 $(efl_doxygen) 202 $(efl_doxygen)
22 cp $(srcdir)/img/* html/ 203 cp $(srcdir)/img/* html/
23 cp $(srcdir)/img/*.eps latex/ 204 cp $(srcdir)/img/*.eps latex/
diff --git a/doc/widgets/Makefile.am b/doc/widgets/Makefile.am
index df26c75..5002c8a 100644
--- a/doc/widgets/Makefile.am
+++ b/doc/widgets/Makefile.am
@@ -6,11 +6,11 @@ include ../../Makefile_Elm_Helpers.am
6 6
7AM_CPPFLAGS = \ 7AM_CPPFLAGS = \
8-I$(top_srcdir) \ 8-I$(top_srcdir) \
9-I$(top_srcdir)/src/lib \ 9-I$(top_srcdir)/src/lib/elementary \
10-I$(top_builddir)/src/lib \ 10-I$(top_builddir)/src/lib/elementary \
11-I$(top_srcdir)/src/bin \ 11-I$(top_srcdir)/src/bin/elementary \
12-DPACKAGE_BIN_DIR=\"$(bindir)\" \ 12-DPACKAGE_BIN_DIR=\"$(bindir)\" \
13-DPACKAGE_DATA_DIR=\"$(datadir)/$(PACKAGE)\" \ 13-DPACKAGE_DATA_DIR=\"$(datadir)/elementary\" \
14-DDOCW_DIR=\"$(abs_top_builddir)/doc/widgets\" \ 14-DDOCW_DIR=\"$(abs_top_builddir)/doc/widgets\" \
15@ELEMENTARY_CFLAGS@ 15@ELEMENTARY_CFLAGS@
16 16
@@ -97,8 +97,17 @@ widget_preview_toolbar \
97widget_preview_web \ 97widget_preview_web \
98widget_preview_win 98widget_preview_win
99 99
100LDADD = $(top_builddir)/src/lib/libelementary.la \ 100LDADD = \
101@ELEMENTARY_LIBS@ 101$(top_builddir)/src/lib/eina/libeina.la \
102$(top_builddir)/src/lib/eo/libeo.la \
103$(top_builddir)/src/lib/efl/libefl.la \
104$(top_builddir)/src/lib/eet/libeet.la \
105$(top_builddir)/src/lib/evas/libevas.la \
106$(top_builddir)/src/lib/ecore/libecore.la \
107$(top_builddir)/src/lib/ecore_evas/libecore_evas.la \
108$(top_builddir)/src/lib/edje/libedje.la \
109$(top_builddir)/src/lib/elementary/libelementary.la \
110@ECORE_EVAS_LDFLAGS@
102 111
103endif 112endif
104 113