diff --git a/.gitignore b/.gitignore index 93406696e..a3d3228df 100644 --- a/.gitignore +++ b/.gitignore @@ -46,21 +46,21 @@ depcomp /doc/cookbook/*.stamp /doc/cookbook/clutter-cookbook.xml /doc/cookbook/clutter-cookbook.html -doc/reference/clutter/clutter-*.txt -!/doc/reference/clutter/clutter-sections.txt -doc/reference/clutter/html -doc/reference/clutter/tmpl -doc/reference/clutter/xml -doc/reference/clutter/clutter.args -doc/reference/clutter/clutter.hierarchy -doc/reference/clutter/clutter.interfaces -doc/reference/clutter/clutter.prerequisites -doc/reference/clutter/clutter.signals -doc/reference/clutter/clutter-docs.xml -doc/reference/clutter/*.stamp -doc/reference/clutter/*.bak -doc/reference/clutter/*.log -doc/reference/clutter/gtkdoc-check.* +doc/reference/clutter-*.txt +!/doc/reference/clutter-sections.txt +doc/reference/html +doc/reference/tmpl +doc/reference/xml +doc/reference/clutter.args +doc/reference/clutter.hierarchy +doc/reference/clutter.interfaces +doc/reference/clutter.prerequisites +doc/reference/clutter.signals +doc/reference/clutter-docs.xml +doc/reference/*.stamp +doc/reference/*.bak +doc/reference/*.log +doc/reference/gtkdoc-check.* gtk-doc.make install-sh libtool diff --git a/configure.ac b/configure.ac index 66f59e25a..ffde96d58 100644 --- a/configure.ac +++ b/configure.ac @@ -1197,8 +1197,7 @@ AC_CONFIG_FILES([ doc/Makefile doc/reference/Makefile - doc/reference/clutter/Makefile - doc/reference/clutter/clutter-docs.xml + doc/reference/clutter-docs.xml doc/common/Makefile doc/cookbook/Makefile doc/cookbook/clutter-cookbook.xml diff --git a/doc/reference/Makefile.am b/doc/reference/Makefile.am index 121968a63..df25a598f 100644 --- a/doc/reference/Makefile.am +++ b/doc/reference/Makefile.am @@ -1 +1,169 @@ -SUBDIRS = clutter +DOC_MODULE = clutter +DOC_MAIN_SGML_FILE = $(DOC_MODULE)-docs.xml +DOC_SOURCE_DIR = $(top_srcdir)/clutter $(top_builddir)/clutter + +SCANGOBJ_OPTIONS = +SCAN_OPTIONS = +MKDB_OPTIONS = --xml-mode --output-format=xml --name-space=clutter +MKTMPL_OPTIONS = +FIXXREF_OPTIONS = \ + --extra-dir=$(GLIB_PREFIX)/share/gtk-doc/html/glib \ + --extra-dir=$(GLIB_PREFIX)/share/gtk-doc/html/gobject \ + --extra-dir=$(CAIRO_PREFIX)/share/gtk-doc/html/cairo \ + --extra-dir=$(PANGO_PREFIX)/share/gtk-doc/html/pango \ + --extra-dir=$(COGL_PREFIX)/share/gtk-doc/html/cogl \ + --extra-dir=$(GDK_PREFIX)/share/gtk-doc/html/gdk \ + --extra-dir=$(ATK_PREFIX)/share/gtk-doc/html/atk + +BUILT_HFILES = \ + clutter-enum-types.h \ + clutter-version.h \ + clutter-marshal.h + +HFILE_GLOB = \ + $(top_srcdir)/clutter/*.h \ + $(top_builddir)/clutter/*.h \ + $(top_srcdir)/clutter/deprecated/*.h \ + $(top_srcdir)/clutter/x11/clutter-x11.h \ + $(top_srcdir)/clutter/x11/clutter-x11-texture-pixmap.h \ + $(top_srcdir)/clutter/x11/clutter-glx-texture-pixmap.h \ + $(top_srcdir)/clutter/egl/clutter-egl.h \ + $(top_builddir)/clutter/cex100/clutter-cex100.h \ + $(top_srcdir)/clutter/win32/clutter-win32.h \ + $(top_srcdir)/clutter/gdk/clutter-gdk.h \ + $(top_srcdir)/clutter/wayland/clutter-wayland.h \ + $(top_srcdir)/clutter/wayland/clutter-wayland-compositor.h \ + $(top_srcdir)/clutter/wayland/clutter-wayland-surface.h \ + $(top_srcdir)/clutter/mir/clutter-mir.h \ + $(top_srcdir)/clutter/cally/*.h + +CFILE_GLOB = \ + $(top_srcdir)/clutter/*.c \ + $(top_srcdir)/clutter/cally/*.c \ + $(top_srcdir)/clutter/cogl/*.c \ + $(top_srcdir)/clutter/x11/*.c \ + $(top_srcdir)/clutter/win32/*.c \ + $(top_srcdir)/clutter/gdk/*.c \ + $(top_srcdir)/clutter/cex100/*.c \ + $(top_srcdir)/clutter/egl/*.c \ + $(top_srcdir)/clutter/wayland/*.c \ + $(top_srcdir)/clutter/mir/*.c \ + $(top_srcdir)/clutter/deprecated/*.c + +IGNORE_HFILES = \ + config.h \ + clutter.h \ + clutter-actor-meta-private.h \ + clutter-actor-private.h \ + clutter-backend-private.h \ + clutter-bezier.h \ + clutter-cogl-compat.h \ + clutter-color-static.h \ + clutter-config.h \ + clutter-constraint-private.h \ + clutter-debug.h \ + clutter-deprecated.h \ + clutter-device-manager-private.h \ + clutter-easing.h \ + clutter-enum-types.h \ + clutter-event-translator.h \ + clutter-flatten-effect.h \ + clutter-gesture-action-private.h \ + clutter-id-pool.h \ + clutter-keysyms.h \ + clutter-keysyms-compat.h \ + clutter-keysyms-table.h \ + clutter-marshal.h \ + clutter-master-clock-default.h \ + clutter-master-clock.h \ + clutter-model-private.h \ + clutter-paint-node-private.h \ + clutter-paint-volume-private.h \ + clutter-private.h \ + clutter-script-private.h \ + clutter-settings-private.h \ + clutter-stage-manager-private.h \ + clutter-stage-private.h \ + clutter-stage-window.h \ + clutter-timeout-interval.h \ + cally-actor-private.h \ + cex100 \ + cogl \ + egl \ + evdev \ + gdk \ + mir \ + osx \ + tslib \ + x11 \ + wayland \ + win32 + +EXTRA_HFILES = \ + $(top_srcdir)/clutter/x11/clutter-x11.h \ + $(top_srcdir)/clutter/x11/clutter-x11-texture-pixmap.h \ + $(top_srcdir)/clutter/x11/clutter-glx-texture-pixmap.h \ + $(top_srcdir)/clutter/egl/clutter-egl.h \ + $(top_srcdir)/clutter/cex100/clutter-cex100.h \ + $(top_srcdir)/clutter/win32/clutter-win32.h \ + $(top_srcdir)/clutter/gdk/clutter-gdk.h \ + $(top_srcdir)/clutter/wayland/clutter-wayland.h \ + $(top_srcdir)/clutter/wayland/clutter-wayland-compositor.h \ + $(top_srcdir)/clutter/wayland/clutter-wayland-surface.h \ + $(top_srcdir)/clutter/mir/clutter-mir.h + +HTML_IMAGES = \ + actor-box.png \ + actor-example.png \ + animator-key-frames.png \ + bin-layout.png \ + box-layout.png \ + constraints-example.png \ + easing-modes.png \ + event-flow.png \ + flow-layout.png \ + path-alpha-func.png \ + offscreen-redirect.png \ + table-layout.png + +SVG_IMAGES = \ + animator-key-frames.svg \ + easing-modes.svg + +content_files = \ + glossary.xml \ + clutter-overview.xml \ + building-clutter.xml \ + running-clutter.xml \ + migrating-ClutterAnimation.xml \ + migrating-ClutterBehaviour.xml \ + migrating-ClutterEffect.xml \ + migrating-ClutterPath.xml + +expand_content_files = \ + glossary.xml \ + clutter-overview.xml \ + building-clutter.xml \ + running-clutter.xml \ + migrating-ClutterAnimation.xml \ + migrating-ClutterBehaviour.xml \ + migrating-ClutterEffect.xml \ + migrating-ClutterPath.xml + +GTKDOC_CFLAGS = -I$(top_srcdir) -I$(top_builddir) -DCLUTTER_DISABLE_DEPRECATION_WARNINGS $(CLUTTER_CFLAGS) +GTKDOC_LIBS = $(top_builddir)/clutter/libclutter-@CLUTTER_API_VERSION@.la $(CLUTTER_LIBS) + +include $(top_srcdir)/gtk-doc.make + +EXTRA_DIST += clutter.types +EXTRA_DIST += $(HTML_IMAGES) $(SVG_IMAGES) + +if ENABLE_GTK_DOC +TESTS_ENVIRONMENT = \ + DOC_MODULE=$(DOC_MODULE) \ + DOC_MAIN_SGML_FILE=$(DOC_MAIN_SGML_FILE) \ + SRCDIR=$(abs_srcdir) \ + BUILDDIR=$(abs_builddir) + +TESTS = $(GTKDOC_CHECK) +endif diff --git a/doc/reference/clutter/actor-box.png b/doc/reference/actor-box.png similarity index 100% rename from doc/reference/clutter/actor-box.png rename to doc/reference/actor-box.png diff --git a/doc/reference/clutter/actor-example.png b/doc/reference/actor-example.png similarity index 100% rename from doc/reference/clutter/actor-example.png rename to doc/reference/actor-example.png diff --git a/doc/reference/clutter/animator-key-frames.png b/doc/reference/animator-key-frames.png similarity index 100% rename from doc/reference/clutter/animator-key-frames.png rename to doc/reference/animator-key-frames.png diff --git a/doc/reference/clutter/animator-key-frames.svg b/doc/reference/animator-key-frames.svg similarity index 100% rename from doc/reference/clutter/animator-key-frames.svg rename to doc/reference/animator-key-frames.svg diff --git a/doc/reference/clutter/bin-layout.png b/doc/reference/bin-layout.png similarity index 100% rename from doc/reference/clutter/bin-layout.png rename to doc/reference/bin-layout.png diff --git a/doc/reference/clutter/box-layout.png b/doc/reference/box-layout.png similarity index 100% rename from doc/reference/clutter/box-layout.png rename to doc/reference/box-layout.png diff --git a/doc/reference/clutter/building-clutter.xml b/doc/reference/building-clutter.xml similarity index 100% rename from doc/reference/clutter/building-clutter.xml rename to doc/reference/building-clutter.xml diff --git a/doc/reference/clutter/clutter-docs.xml.in b/doc/reference/clutter-docs.xml.in similarity index 100% rename from doc/reference/clutter/clutter-docs.xml.in rename to doc/reference/clutter-docs.xml.in diff --git a/doc/reference/clutter/clutter-overview.xml b/doc/reference/clutter-overview.xml similarity index 100% rename from doc/reference/clutter/clutter-overview.xml rename to doc/reference/clutter-overview.xml diff --git a/doc/reference/clutter/clutter-sections.txt b/doc/reference/clutter-sections.txt similarity index 100% rename from doc/reference/clutter/clutter-sections.txt rename to doc/reference/clutter-sections.txt diff --git a/doc/reference/clutter/clutter.types b/doc/reference/clutter.types similarity index 100% rename from doc/reference/clutter/clutter.types rename to doc/reference/clutter.types diff --git a/doc/reference/clutter/Makefile.am b/doc/reference/clutter/Makefile.am deleted file mode 100644 index df25a598f..000000000 --- a/doc/reference/clutter/Makefile.am +++ /dev/null @@ -1,169 +0,0 @@ -DOC_MODULE = clutter -DOC_MAIN_SGML_FILE = $(DOC_MODULE)-docs.xml -DOC_SOURCE_DIR = $(top_srcdir)/clutter $(top_builddir)/clutter - -SCANGOBJ_OPTIONS = -SCAN_OPTIONS = -MKDB_OPTIONS = --xml-mode --output-format=xml --name-space=clutter -MKTMPL_OPTIONS = -FIXXREF_OPTIONS = \ - --extra-dir=$(GLIB_PREFIX)/share/gtk-doc/html/glib \ - --extra-dir=$(GLIB_PREFIX)/share/gtk-doc/html/gobject \ - --extra-dir=$(CAIRO_PREFIX)/share/gtk-doc/html/cairo \ - --extra-dir=$(PANGO_PREFIX)/share/gtk-doc/html/pango \ - --extra-dir=$(COGL_PREFIX)/share/gtk-doc/html/cogl \ - --extra-dir=$(GDK_PREFIX)/share/gtk-doc/html/gdk \ - --extra-dir=$(ATK_PREFIX)/share/gtk-doc/html/atk - -BUILT_HFILES = \ - clutter-enum-types.h \ - clutter-version.h \ - clutter-marshal.h - -HFILE_GLOB = \ - $(top_srcdir)/clutter/*.h \ - $(top_builddir)/clutter/*.h \ - $(top_srcdir)/clutter/deprecated/*.h \ - $(top_srcdir)/clutter/x11/clutter-x11.h \ - $(top_srcdir)/clutter/x11/clutter-x11-texture-pixmap.h \ - $(top_srcdir)/clutter/x11/clutter-glx-texture-pixmap.h \ - $(top_srcdir)/clutter/egl/clutter-egl.h \ - $(top_builddir)/clutter/cex100/clutter-cex100.h \ - $(top_srcdir)/clutter/win32/clutter-win32.h \ - $(top_srcdir)/clutter/gdk/clutter-gdk.h \ - $(top_srcdir)/clutter/wayland/clutter-wayland.h \ - $(top_srcdir)/clutter/wayland/clutter-wayland-compositor.h \ - $(top_srcdir)/clutter/wayland/clutter-wayland-surface.h \ - $(top_srcdir)/clutter/mir/clutter-mir.h \ - $(top_srcdir)/clutter/cally/*.h - -CFILE_GLOB = \ - $(top_srcdir)/clutter/*.c \ - $(top_srcdir)/clutter/cally/*.c \ - $(top_srcdir)/clutter/cogl/*.c \ - $(top_srcdir)/clutter/x11/*.c \ - $(top_srcdir)/clutter/win32/*.c \ - $(top_srcdir)/clutter/gdk/*.c \ - $(top_srcdir)/clutter/cex100/*.c \ - $(top_srcdir)/clutter/egl/*.c \ - $(top_srcdir)/clutter/wayland/*.c \ - $(top_srcdir)/clutter/mir/*.c \ - $(top_srcdir)/clutter/deprecated/*.c - -IGNORE_HFILES = \ - config.h \ - clutter.h \ - clutter-actor-meta-private.h \ - clutter-actor-private.h \ - clutter-backend-private.h \ - clutter-bezier.h \ - clutter-cogl-compat.h \ - clutter-color-static.h \ - clutter-config.h \ - clutter-constraint-private.h \ - clutter-debug.h \ - clutter-deprecated.h \ - clutter-device-manager-private.h \ - clutter-easing.h \ - clutter-enum-types.h \ - clutter-event-translator.h \ - clutter-flatten-effect.h \ - clutter-gesture-action-private.h \ - clutter-id-pool.h \ - clutter-keysyms.h \ - clutter-keysyms-compat.h \ - clutter-keysyms-table.h \ - clutter-marshal.h \ - clutter-master-clock-default.h \ - clutter-master-clock.h \ - clutter-model-private.h \ - clutter-paint-node-private.h \ - clutter-paint-volume-private.h \ - clutter-private.h \ - clutter-script-private.h \ - clutter-settings-private.h \ - clutter-stage-manager-private.h \ - clutter-stage-private.h \ - clutter-stage-window.h \ - clutter-timeout-interval.h \ - cally-actor-private.h \ - cex100 \ - cogl \ - egl \ - evdev \ - gdk \ - mir \ - osx \ - tslib \ - x11 \ - wayland \ - win32 - -EXTRA_HFILES = \ - $(top_srcdir)/clutter/x11/clutter-x11.h \ - $(top_srcdir)/clutter/x11/clutter-x11-texture-pixmap.h \ - $(top_srcdir)/clutter/x11/clutter-glx-texture-pixmap.h \ - $(top_srcdir)/clutter/egl/clutter-egl.h \ - $(top_srcdir)/clutter/cex100/clutter-cex100.h \ - $(top_srcdir)/clutter/win32/clutter-win32.h \ - $(top_srcdir)/clutter/gdk/clutter-gdk.h \ - $(top_srcdir)/clutter/wayland/clutter-wayland.h \ - $(top_srcdir)/clutter/wayland/clutter-wayland-compositor.h \ - $(top_srcdir)/clutter/wayland/clutter-wayland-surface.h \ - $(top_srcdir)/clutter/mir/clutter-mir.h - -HTML_IMAGES = \ - actor-box.png \ - actor-example.png \ - animator-key-frames.png \ - bin-layout.png \ - box-layout.png \ - constraints-example.png \ - easing-modes.png \ - event-flow.png \ - flow-layout.png \ - path-alpha-func.png \ - offscreen-redirect.png \ - table-layout.png - -SVG_IMAGES = \ - animator-key-frames.svg \ - easing-modes.svg - -content_files = \ - glossary.xml \ - clutter-overview.xml \ - building-clutter.xml \ - running-clutter.xml \ - migrating-ClutterAnimation.xml \ - migrating-ClutterBehaviour.xml \ - migrating-ClutterEffect.xml \ - migrating-ClutterPath.xml - -expand_content_files = \ - glossary.xml \ - clutter-overview.xml \ - building-clutter.xml \ - running-clutter.xml \ - migrating-ClutterAnimation.xml \ - migrating-ClutterBehaviour.xml \ - migrating-ClutterEffect.xml \ - migrating-ClutterPath.xml - -GTKDOC_CFLAGS = -I$(top_srcdir) -I$(top_builddir) -DCLUTTER_DISABLE_DEPRECATION_WARNINGS $(CLUTTER_CFLAGS) -GTKDOC_LIBS = $(top_builddir)/clutter/libclutter-@CLUTTER_API_VERSION@.la $(CLUTTER_LIBS) - -include $(top_srcdir)/gtk-doc.make - -EXTRA_DIST += clutter.types -EXTRA_DIST += $(HTML_IMAGES) $(SVG_IMAGES) - -if ENABLE_GTK_DOC -TESTS_ENVIRONMENT = \ - DOC_MODULE=$(DOC_MODULE) \ - DOC_MAIN_SGML_FILE=$(DOC_MAIN_SGML_FILE) \ - SRCDIR=$(abs_srcdir) \ - BUILDDIR=$(abs_builddir) - -TESTS = $(GTKDOC_CHECK) -endif diff --git a/doc/reference/clutter/constraints-example.png b/doc/reference/constraints-example.png similarity index 100% rename from doc/reference/clutter/constraints-example.png rename to doc/reference/constraints-example.png diff --git a/doc/reference/clutter/easing-modes.png b/doc/reference/easing-modes.png similarity index 100% rename from doc/reference/clutter/easing-modes.png rename to doc/reference/easing-modes.png diff --git a/doc/reference/clutter/easing-modes.svg b/doc/reference/easing-modes.svg similarity index 100% rename from doc/reference/clutter/easing-modes.svg rename to doc/reference/easing-modes.svg diff --git a/doc/reference/clutter/event-flow.dia b/doc/reference/event-flow.dia similarity index 100% rename from doc/reference/clutter/event-flow.dia rename to doc/reference/event-flow.dia diff --git a/doc/reference/clutter/event-flow.png b/doc/reference/event-flow.png similarity index 100% rename from doc/reference/clutter/event-flow.png rename to doc/reference/event-flow.png diff --git a/doc/reference/clutter/flow-layout.png b/doc/reference/flow-layout.png similarity index 100% rename from doc/reference/clutter/flow-layout.png rename to doc/reference/flow-layout.png diff --git a/doc/reference/clutter/glossary.xml b/doc/reference/glossary.xml similarity index 100% rename from doc/reference/clutter/glossary.xml rename to doc/reference/glossary.xml diff --git a/doc/reference/clutter/migrating-ClutterAnimation.xml b/doc/reference/migrating-ClutterAnimation.xml similarity index 100% rename from doc/reference/clutter/migrating-ClutterAnimation.xml rename to doc/reference/migrating-ClutterAnimation.xml diff --git a/doc/reference/clutter/migrating-ClutterBehaviour.xml b/doc/reference/migrating-ClutterBehaviour.xml similarity index 100% rename from doc/reference/clutter/migrating-ClutterBehaviour.xml rename to doc/reference/migrating-ClutterBehaviour.xml diff --git a/doc/reference/clutter/migrating-ClutterEffect.xml b/doc/reference/migrating-ClutterEffect.xml similarity index 100% rename from doc/reference/clutter/migrating-ClutterEffect.xml rename to doc/reference/migrating-ClutterEffect.xml diff --git a/doc/reference/clutter/migrating-ClutterPath.xml b/doc/reference/migrating-ClutterPath.xml similarity index 100% rename from doc/reference/clutter/migrating-ClutterPath.xml rename to doc/reference/migrating-ClutterPath.xml diff --git a/doc/reference/clutter/offscreen-redirect.png b/doc/reference/offscreen-redirect.png similarity index 100% rename from doc/reference/clutter/offscreen-redirect.png rename to doc/reference/offscreen-redirect.png diff --git a/doc/reference/clutter/path-alpha-func.png b/doc/reference/path-alpha-func.png similarity index 100% rename from doc/reference/clutter/path-alpha-func.png rename to doc/reference/path-alpha-func.png diff --git a/doc/reference/clutter/running-clutter.xml b/doc/reference/running-clutter.xml similarity index 100% rename from doc/reference/clutter/running-clutter.xml rename to doc/reference/running-clutter.xml diff --git a/doc/reference/clutter/table-layout.png b/doc/reference/table-layout.png similarity index 100% rename from doc/reference/clutter/table-layout.png rename to doc/reference/table-layout.png