a start on an example of what i was thinking of for widget docs... eg

example screenshots auto-generated by scripts when we do "make doc"
with those images put in the docs for that widget. some examples of
usage.

git-svn-id: svn+ssh://svn.enlightenment.org/var/svn/e/trunk/elementary@61078 7cbeb6ba-43b4-40fd-8cce-4c39aea84d33

diff --git a/doc/Makefile.am b/doc/Makefile.am
index f954592..e356963 100644 (file)
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -6,10 +6,43 @@ PACKAGE_DOCNAME = $(PACKAGE_TARNAME)-$(PACKAGE_VERSION)-doc
 
 if EFL_BUILD_DOC
 
+AM_CPPFLAGS = \
+-I$(top_srcdir) \
+-I$(top_srcdir)/src/lib \
+-I$(top_builddir)/src/lib \
+-I$(top_srcdir)/src/bin \
+-DPACKAGE_BIN_DIR=\"$(bindir)\" \
+-DPACKAGE_DATA_DIR=\"$(datadir)/$(PACKAGE)\" \
+@ELEMENTARY_CFLAGS@ \
+@ELEMENTARY_X_CFLAGS@ \
+@ELEMENTARY_FB_CFLAGS@ \
+@ELEMENTARY_WIN32_CFLAGS@ \
+@ELEMENTARY_WINCE_CFLAGS@ \
+@ELEMENTARY_EDBUS_CFLAGS@ \
+@ELEMENTARY_EFREET_CFLAGS@ \
+@ELEMENTARY_EWEATHER_CFLAGS@ \
+@ELEMENTARY_ETHUMB_CFLAGS@ \
+@EIO_CFLAGS@
+
+bin_PROGRAMS = \
+widget_preview_button1 \
+widget_preview_button2 \
+widget_preview_button3
+
+widget_preview_button1_SOURCES = widget_preview_button1.c
+widget_preview_button1_LDADD = $(top_builddir)/src/lib/libelementary.la @ELEMENTARY_EWEATHER_LIBS@ @ELEMENTARY_EDBUS_LIBS@ @ELEMENTARY_EFREET_LIBS@ @ELEMENTARY_LIBS@ @EIO_LIBS@ @my_libs@
+widget_preview_button2_SOURCES = widget_preview_button2.c
+widget_preview_button2_LDADD = $(top_builddir)/src/lib/libelementary.la @ELEMENTARY_EWEATHER_LIBS@ @ELEMENTARY_EDBUS_LIBS@ @ELEMENTARY_EFREET_LIBS@ @ELEMENTARY_LIBS@ @EIO_LIBS@ @my_libs@
+widget_preview_button3_SOURCES = widget_preview_button3.c
+widget_preview_button3_LDADD = $(top_builddir)/src/lib/libelementary.la @ELEMENTARY_EWEATHER_LIBS@ @ELEMENTARY_EDBUS_LIBS@ @ELEMENTARY_EFREET_LIBS@ @ELEMENTARY_LIBS@ @EIO_LIBS@ @my_libs@
+
 doc-clean:
-       rm -rf html/ latex/ man/ xml/ $(top_builddir)/$(PACKAGE_DOCNAME).tar*
+       rm -rf img/widget html/ latex/ man/ xml/ $(top_builddir)/$(PACKAGE_DOCNAME).tar*
 
 doc: all doc-clean
+       $(top_srcdir)/doc/shot.sh ./img/widget/button preview-00.png $(top_builddir)/doc/widget_preview_button1 160 50
+       $(top_srcdir)/doc/shot.sh ./img/widget/button preview-01.png $(top_builddir)/doc/widget_preview_button2 160 50
+       $(top_srcdir)/doc/shot.sh ./img/widget/button preview-02.png $(top_builddir)/doc/widget_preview_button3 160 50
        $(efl_doxygen)
        cp -r $(srcdir)/img/* html/
        cp -r $(srcdir)/img/* latex/

diff --git a/doc/shot.sh b/doc/shot.sh
new file mode 100755 (executable)
index 0000000..793bef9
--- /dev/null
+++ b/doc/shot.sh
@@ -0,0 +1,14 @@
+#!/bin/sh
+
+DIR=$1
+shift
+FILE=$1
+shift
+
+export ELM_THEME=default
+export ELM_SCALE=1.0
+export ELM_ENGINE=shot:delay=0.5:file=$DIR/$FILE
+
+mkdir -p $DIR || true
+
+exec $@

diff --git a/doc/widget_preview_button1.c b/doc/widget_preview_button1.c
new file mode 100644 (file)
index 0000000..966fe0b
--- /dev/null
+++ b/doc/widget_preview_button1.c
@@ -0,0 +1,10 @@
+#include "widget_preview_tmpl_head.c"
+
+Evas_Object *o = elm_button_add(win);
+evas_object_size_hint_weight_set(o, EVAS_HINT_EXPAND, EVAS_HINT_EXPAND);
+elm_win_resize_object_add(win, o);
+evas_object_show(o);
+
+elm_object_text_set(o, "Button");
+
+#include "widget_preview_tmpl_foot.c"

diff --git a/doc/widget_preview_button2.c b/doc/widget_preview_button2.c
new file mode 100644 (file)
index 0000000..cc15394
--- /dev/null
+++ b/doc/widget_preview_button2.c
@@ -0,0 +1,15 @@
+#include "widget_preview_tmpl_head.c"
+
+Evas_Object *o = elm_button_add(win);
+evas_object_size_hint_weight_set(o, EVAS_HINT_EXPAND, EVAS_HINT_EXPAND);
+elm_win_resize_object_add(win, o);
+evas_object_show(o);
+
+elm_object_text_set(o, "Button");
+
+Evas_Object *o2 = elm_icon_add(win);
+elm_icon_file_set(o2, "img/elementary.png", NULL);
+elm_button_icon_set(o, o2);
+evas_object_show(o2);
+
+#include "widget_preview_tmpl_foot.c"

diff --git a/doc/widget_preview_button3.c b/doc/widget_preview_button3.c
new file mode 100644 (file)
index 0000000..743c0d3
--- /dev/null
+++ b/doc/widget_preview_button3.c
@@ -0,0 +1,13 @@
+#include "widget_preview_tmpl_head.c"
+
+Evas_Object *o = elm_button_add(win);
+evas_object_size_hint_weight_set(o, EVAS_HINT_EXPAND, EVAS_HINT_EXPAND);
+elm_win_resize_object_add(win, o);
+evas_object_show(o);
+
+Evas_Object *o2 = elm_icon_add(win);
+elm_icon_file_set(o2, "img/elementary.png", NULL);
+elm_button_icon_set(o, o2);
+evas_object_show(o2);
+
+#include "widget_preview_tmpl_foot.c"

diff --git a/doc/widget_preview_tmpl_foot.c b/doc/widget_preview_tmpl_foot.c
new file mode 100644 (file)
index 0000000..08c8fdc
--- /dev/null
+++ b/doc/widget_preview_tmpl_foot.c
@@ -0,0 +1,10 @@
+   
+   evas_object_resize(win, w, h);
+   evas_object_show(win);
+   elm_run();
+   elm_shutdown();
+   return 0;
+}
+ELM_MAIN()
+
+      

diff --git a/doc/widget_preview_tmpl_head.c b/doc/widget_preview_tmpl_head.c
new file mode 100644 (file)
index 0000000..2c7f3be
--- /dev/null
+++ b/doc/widget_preview_tmpl_head.c
@@ -0,0 +1,14 @@
+#include <Elementary.h>
+
+EAPI int
+elm_main(int argc, char **argv)
+{
+   Evas_Object *win;
+   Evas_Coord w, h;
+   
+   w = atoi(argv[1]);
+   h = atoi(argv[2]);
+   
+   win = elm_win_add(NULL, "main", ELM_WIN_BASIC);
+   elm_win_alpha_set(win, EINA_TRUE);
+   

diff --git a/src/lib/Elementary.h.in b/src/lib/Elementary.h.in
index 3362baa..eeacb88 100644 (file)
--- a/src/lib/Elementary.h.in
+++ b/src/lib/Elementary.h.in
@@ -2358,6 +2358,10 @@ extern "C" {
    /**
     * @defgroup Button Button
     *
+    * @image html  widget/button/preview-00.png
+    * @image html  widget/button/preview-01.png
+    * @image html  widget/button/preview-02.png
+    * 
     * This is a push-button. Press it and run some function. It can contain
     * a simple label and icon object and it also has an autorepeat feature.
     *