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)
downloadefl-b6a81b6e7bbcc3991c6efc11d14802bc028d9365.tar.gz
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 0000000000..199e7ee748
--- /dev/null
+++ b/doc/.gitignore
@@ -0,0 +1,7 @@
+/elementary.dox
+/Doxyfile
+/widget_preview_*
+/widgets/widget_preview_*
+/html
+/man
+/latex
diff --git a/doc/Makefile.am b/doc/Makefile.am
index 2765bb18ef..9b89fb20da 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -1,4 +1,4 @@
-SUBDIRS = previews
+SUBDIRS = previews widgets
MAINTAINERCLEANFILES = Makefile.in
@@ -16,8 +16,189 @@ previews-build:
previews-data:
@$(MAKE) -C previews doc
+# dir:file name:executable:width:height
+WGT_PREVIEW = \
+ actionslider:preview-00.png:widget_preview_actionslider:120:30 \
+ bg:preview-00.png:widget_preview_bg:50:50 \
+ box:preview-00.png:widget_preview_box:200:160 \
+ bubble:preview-00.png:widget_preview_bubble1:160:50 \
+ bubble:preview-01.png:widget_preview_bubble2:160:50 \
+ bubble:preview-02.png:widget_preview_bubble3:160:50 \
+ button:preview-00.png:widget_preview_button1:160:50 \
+ button:preview-01.png:widget_preview_button2:160:50 \
+ button:preview-02.png:widget_preview_button3:160:50 \
+ calendar:preview-00.png:widget_preview_calendar:300:300 \
+ check:preview-00.png:widget_preview_check1:160:50 \
+ check:preview-01.png:widget_preview_check2:160:50 \
+ check:preview-02.png:widget_preview_check3:160:50 \
+ clock:preview-00.png:widget_preview_clock:200:100 \
+ colorselector:preview-00.png:widget_preview_colorselector:320:300 \
+ conformant:preview-00.png:widget_preview_conformant:200:400 \
+ combobox:preview-00.png:widget_preview_combobox:300:300 \
+ ctxpopup:preview-00.png:widget_preview_ctxpopup:200:130 \
+ datetime:preview-00.png:widget_preview_datetime1:360:60 \
+ datetime:preview-01.png:widget_preview_datetime2:200:60 \
+ datetime:preview-02.png:widget_preview_datetime3:200:60 \
+ dayselector:preview-00.png:widget_preview_dayselector:350:50 \
+ diskselector:preview-00.png:widget_preview_diskselector:120:50 \
+ entry:preview-00.png:widget_preview_entry1:160:50 \
+ entry:preview-01.png:widget_preview_entry2:160:50 \
+ entry:preview-02.png:widget_preview_entry3:160:50 \
+ entry:preview-03.png:widget_preview_entry4:160:50 \
+ fileselector:preview-00.png:widget_preview_fileselector:300:300 \
+ fileselector_button:preview-00.png:widget_preview_fileselector_button1:200:50 \
+ fileselector_button:preview-01.png:widget_preview_fileselector_button2:200:50 \
+ fileselector_button:preview-02.png:widget_preview_fileselector_button3:160:50 \
+ fileselector_entry:preview-00.png:widget_preview_fileselector_entry:70:50 \
+ flip:preview-00.png:widget_preview_flip:100:100 \
+ flipselector:preview-00.png:widget_preview_flipselector:100:60 \
+ frame:preview-00.png:widget_preview_frame:100:50 \
+ gengrid:preview-00.png:widget_preview_gengrid:200:160 \
+ genlist:preview-00.png:widget_preview_genlist1:200:200 \
+ genlist:preview-01.png:widget_preview_genlist2:200:160 \
+ genlist:preview-02.png:widget_preview_genlist3:200:160 \
+ genlist:preview-03.png:widget_preview_genlist4:200:160 \
+ genlist:preview-04.png:widget_preview_genlist5:200:160 \
+ hover:preview-00.png:widget_preview_hover:90:170 \
+ hoversel:preview-00.png:widget_preview_hoversel:90:170 \
+ icon:preview-00.png:widget_preview_icon:50:50 \
+ image:preview-00.png:widget_preview_image:50:50 \
+ index:preview-00.png:widget_preview_index:200:160 \
+ inwin:preview-00.png:widget_preview_inwin1:200:160 \
+ inwin:preview-01.png:widget_preview_inwin2:200:160 \
+ inwin:preview-02.png:widget_preview_inwin3:200:160 \
+ label:preview-00.png:widget_preview_label:70:30 \
+ layout:preview-00.png:widget_preview_layout:200:160 \
+ list:preview-00.png:widget_preview_list:200:200 \
+ map:preview-00.png:widget_preview_map:256:256 \
+ mapbuf:preview-00.png:widget_preview_mapbuf:200:200 \
+ menu:preview-00.png:widget_preview_menu:100:100 \
+ notify:preview-00.png:widget_preview_notify:60:30 \
+ panel:preview-00.png:widget_preview_panel:150:50 \
+ panes:preview-00.png:widget_preview_panes:200:100 \
+ photocam:preview-00.png:widget_preview_photocam:243:162 \
+ popup:preview-00.png:widget_preview_popup:480:400 \
+ prefs:preview-00.png:widget_preview_prefs:200:160 \
+ prefs:preview-00.png:widget_preview_prefs:280:250 \
+ progressbar:preview-00.png:widget_preview_progressbar:150:50 \
+ radio:preview-00.png:widget_preview_radio:60:20 \
+ scroller:preview-00.png:widget_preview_scroller:100:30 \
+ segment_control:preview-00.png:widget_preview_segment_control:240:120 \
+ separator:preview-00.png:widget_preview_separator:10:80 \
+ slider:preview-00.png:widget_preview_slider:200:100 \
+ slideshow:preview-00.png:widget_preview_slideshow:50:50 \
+ spinner:preview-00.png:widget_preview_spinner:160:30 \
+ table::preview-00.png:widget_preview_table:100:100 \
+ table:preview-00.png:widget_preview_table:100:100 \
+ thumb:preview-00.png:widget_preview_thumb:100:100 \
+ toolbar:preview-00.png:widget_preview_toolbar:300:100 \
+ web:preview-00.png:widget_preview_web:300:300 \
+ win:preview-00.png:widget_preview_win:200:200
-doc: all previews-build previews-data
+# put in here every elm widget, so that it gets its hierarchy tree built
+# then, make a reference to the generated image, in the form
+# @image html <WGTNAME>_inheritance_tree.{png,eps}
+WGT_TREE = \
+ actionslider \
+ bg \
+ box \
+ bubble \
+ button \
+ calendar \
+ check \
+ clock \
+ colorselector \
+ conformant \
+ container \
+ combobox \
+ ctxpopup \
+ datetime \
+ dayselector \
+ diskselector \
+ entry \
+ fileselector \
+ fileselector_button \
+ fileselector_entry \
+ flip \
+ flipselector \
+ frame \
+ gengrid \
+ genlist \
+ gesture_layer \
+ glview \
+ grid \
+ hover \
+ hoversel \
+ icon \
+ image \
+ index \
+ inwin \
+ label \
+ layout \
+ list \
+ map \
+ mapbuf \
+ menu \
+ multibuttonentry \
+ naviframe \
+ notify \
+ panel \
+ panes \
+ photo \
+ photocam \
+ player \
+ plug \
+ popup \
+ prefs \
+ progressbar \
+ radio \
+ route \
+ scroller \
+ segment_control \
+ separator \
+ slider \
+ slideshow \
+ spinner \
+ table \
+ thumb \
+ toolbar \
+ video \
+ web \
+ win
+
+widget-build:
+ @$(MAKE) -C widgets
+
+widget-preview: widget-build
+ @for ss in $(WGT_PREVIEW); do \
+ ENTRY=($${ss//:/ }) ; \
+ DIR=$${ENTRY[0]} ; \
+ SS=$${ENTRY[1]} ; \
+ BIN=$${ENTRY[2]} ; \
+ X=$${ENTRY[3]} ; \
+ Y=$${ENTRY[4]} ; \
+ echo "Generating widget preview image" $${SS} "for widget" $${DIR}; \
+ $(top_srcdir)/doc/shot.sh $(top_builddir)/doc/html/img/widget/$${DIR} $${SS} $(top_builddir)/doc/widgets/$${BIN} $${X} $${Y} ; \
+ mkdir -p $(top_builddir)/doc/latex/img/widget/$${DIR} ; \
+ convert $(top_builddir)/doc/html/img/widget/$${DIR}/$${SS} $(top_builddir)/doc/latex/img/widget/$${DIR}/$${SS/.png/.eps} ; \
+ done
+
+widget-tree-figures: doc
+ $(srcdir)/widget_hierarchy.py --scan $(top_srcdir)/src/lib -o $(builddir)/widget_tree.p;
+ $(srcdir)/widget_hierarchy.py --tree -i $(builddir)/widget_tree.p > $(builddir)/widgets_tree.dot;
+ dot -Tpng -o $(top_srcdir)/doc/img/elm-widget-tree.png $(top_builddir)/doc/widgets_tree.dot;
+ convert $(top_srcdir)/doc/img/elm-widget-tree.png $(top_srcdir)/doc/img/"elm-widget-tree.eps";
+ @for wgt in $(WGT_TREE); do \
+ WGT_FILE_NAME="WNAME_inheritance_tree.dot"; \
+ WGT_FILE_NAME=$${WGT_FILE_NAME/WNAME/$${wgt}}; \
+ echo "Generating widget inheritance tree image for widget" $${wgt}; \
+ $(srcdir)/widget_hierarchy.py --widget=$${wgt} -i $(top_builddir)/doc/widget_tree.p > $(top_builddir)/doc/$${WGT_FILE_NAME}; \
+ dot -Tpng -o $(top_srcdir)/doc/img/$${WGT_FILE_NAME/.dot/.png} $(top_builddir)/doc/$${WGT_FILE_NAME}; \
+ convert $(top_srcdir)/doc/img/$${WGT_FILE_NAME/.dot/.png} $(top_srcdir)/doc/img/$${WGT_FILE_NAME/.dot/.eps}; \
+ rm $${WGT_FILE_NAME}; \
+ done
+
+doc: all previews-build previews-data widget-preview
$(efl_doxygen)
cp $(srcdir)/img/* html/
cp $(srcdir)/img/*.eps latex/
diff --git a/doc/widgets/Makefile.am b/doc/widgets/Makefile.am
index df26c75726..5002c8a144 100644
--- a/doc/widgets/Makefile.am
+++ b/doc/widgets/Makefile.am
@@ -6,11 +6,11 @@ include ../../Makefile_Elm_Helpers.am
AM_CPPFLAGS = \
-I$(top_srcdir) \
--I$(top_srcdir)/src/lib \
--I$(top_builddir)/src/lib \
--I$(top_srcdir)/src/bin \
+-I$(top_srcdir)/src/lib/elementary \
+-I$(top_builddir)/src/lib/elementary \
+-I$(top_srcdir)/src/bin/elementary \
-DPACKAGE_BIN_DIR=\"$(bindir)\" \
--DPACKAGE_DATA_DIR=\"$(datadir)/$(PACKAGE)\" \
+-DPACKAGE_DATA_DIR=\"$(datadir)/elementary\" \
-DDOCW_DIR=\"$(abs_top_builddir)/doc/widgets\" \
@ELEMENTARY_CFLAGS@
@@ -97,8 +97,17 @@ widget_preview_toolbar \
widget_preview_web \
widget_preview_win
-LDADD = $(top_builddir)/src/lib/libelementary.la \
-@ELEMENTARY_LIBS@
+LDADD = \
+$(top_builddir)/src/lib/eina/libeina.la \
+$(top_builddir)/src/lib/eo/libeo.la \
+$(top_builddir)/src/lib/efl/libefl.la \
+$(top_builddir)/src/lib/eet/libeet.la \
+$(top_builddir)/src/lib/evas/libevas.la \
+$(top_builddir)/src/lib/ecore/libecore.la \
+$(top_builddir)/src/lib/ecore_evas/libecore_evas.la \
+$(top_builddir)/src/lib/edje/libedje.la \
+$(top_builddir)/src/lib/elementary/libelementary.la \
+@ECORE_EVAS_LDFLAGS@
endif