ffd5fb172b
Clutter copies the gtk-doc from the usual gtk+ template, and has a version.xml.in containing only: @VERSION@ Without a newline at the end. Unfortunately, it appears that autoconf has started adding a newline to the generated version.xml which then is used as the payload for the "version" XML entity. Instead of using a secondary file we can make configure generate the whole clutter-docs.xml and cogl-docs.xml files from a template; this way we also get the ability to substitute more autoconf variables into the documentation -- if needs be.
154 lines
4.9 KiB
Makefile
154 lines
4.9 KiB
Makefile
## Process this file with automake to produce Makefile.in
|
|
|
|
# We require automake 1.6 at least.
|
|
AUTOMAKE_OPTIONS = 1.6
|
|
|
|
# This is a blank Makefile.am for using gtk-doc.
|
|
# Copy this to your project's API docs directory and modify the variables to
|
|
# suit your project. See the GTK+ Makefiles in gtk+/docs/reference for examples
|
|
# of using the various options.
|
|
|
|
# The name of the module, e.g. 'glib'.
|
|
DOC_MODULE=clutter
|
|
|
|
# The top-level SGML file. You can change this if you want to.
|
|
DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.xml
|
|
|
|
# The directory containing the source code. Relative to $(srcdir).
|
|
# gtk-doc will search all .c & .h files beneath here for inline comments
|
|
# documenting the functions and macros.
|
|
# e.g. DOC_SOURCE_DIR=../../../gtk
|
|
DOC_SOURCE_DIR=../../../clutter
|
|
|
|
# Extra options to pass to gtkdoc-scangobj. Not normally needed.
|
|
SCANGOBJ_OPTIONS=--type-init-func="clutter_base_init()"
|
|
|
|
# Extra options to supply to gtkdoc-scan.
|
|
# e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED"
|
|
SCAN_OPTIONS=--deprecated-guards="CLUTTER_DISABLE_DEPRECATED"
|
|
|
|
# Extra options to supply to gtkdoc-mkdb.
|
|
# e.g. MKDB_OPTIONS=--sgml-mode --output-format=xml
|
|
MKDB_OPTIONS=--sgml-mode --output-format=xml --name-space=clutter
|
|
|
|
# Extra options to supply to gtkdoc-mktmpl
|
|
# e.g. MKTMPL_OPTIONS=--only-section-tmpl
|
|
MKTMPL_OPTIONS=
|
|
|
|
# Extra options to supply to gtkdoc-fixref. Not normally needed.
|
|
# e.g. FIXXREF_OPTIONS=--extra-dir=../gdk-pixbuf/html --extra-dir=../gdk/html
|
|
FIXXREF_OPTIONS=\
|
|
--extra-dir=$(GLIB_PREFIX)/share/gtk-doc/html/gobject \
|
|
--extra-dir=$(GLIB_PREFIX)/share/gtk-doc/html/glib \
|
|
--extra-dir=$(PANGO_PREFIX)/share/gtk-doc/html/pango \
|
|
--extra-dir=$(GDPIXBUF_PREFIX)/share/gtk-doc/html/gdk-pixbuf
|
|
|
|
# Used for dependencies. The docs will be rebuilt if any of these change.
|
|
# e.g. HFILE_GLOB=$(top_srcdir)/gtk/*.h
|
|
# e.g. CFILE_GLOB=$(top_srcdir)/gtk/*.c
|
|
HFILE_GLOB=$(top_srcdir)/clutter/*.h \
|
|
$(top_srcdir)/clutter/x11/clutter-x11.h \
|
|
$(top_srcdir)/clutter/x11/clutter-x11-texture-pixmap.h \
|
|
$(top_srcdir)/clutter/glx/clutter-glx-texture-pixmap.h \
|
|
$(top_srcdir)/clutter/eglnative/clutter-egl.h \
|
|
$(top_srcdir)/clutter/eglx/clutter-eglx.h \
|
|
$(top_srcdir)/clutter/win32/clutter-win32.h
|
|
CFILE_GLOB=$(top_srcdir)/clutter/*.c \
|
|
$(top_srcdir)/clutter/x11/*.c \
|
|
$(top_srcdir)/clutter/glx/*.c \
|
|
$(top_srcdir)/clutter/win32/*.c \
|
|
$(top_srcdir)/clutter/eglnative/*.c \
|
|
$(top_srcdir)/clutter/eglx/*.c
|
|
|
|
# Header files to ignore when scanning.
|
|
# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h
|
|
IGNORE_HFILES=\
|
|
clutter.h \
|
|
clutter-bezier.h \
|
|
clutter-debug.h \
|
|
clutter-deprecated.h \
|
|
clutter-enum-types.h \
|
|
clutter-json.h \
|
|
clutter-keysyms.h \
|
|
clutter-keysyms-table.h \
|
|
clutter-marshal.h \
|
|
clutter-master-clock.h \
|
|
clutter-model-private.h \
|
|
clutter-private.h \
|
|
clutter-id-pool.h \
|
|
clutter-script-private.h \
|
|
clutter-stage-manager.h \
|
|
clutter-stage-window.h \
|
|
clutter-timeout-interval.h \
|
|
stamp-clutter-enum-types.h \
|
|
stamp-clutter-marshal.h \
|
|
cogl \
|
|
eglnative \
|
|
eglx \
|
|
fruity \
|
|
glx \
|
|
osx \
|
|
x11 \
|
|
json \
|
|
pango \
|
|
sdl \
|
|
win32
|
|
|
|
EXTRA_HFILES=\
|
|
../../../clutter/x11/clutter-x11.h \
|
|
../../../clutter/x11/clutter-x11-texture-pixmap.h \
|
|
../../../clutter/glx/clutter-glx-texture-pixmap.h \
|
|
../../../clutter/eglnative/clutter-egl.h \
|
|
../../../clutter/eglx/clutter-eglx.h \
|
|
../../../clutter/win32/clutter-win32.h
|
|
|
|
# Images to copy into HTML directory.
|
|
# e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png
|
|
HTML_IMAGES=\
|
|
actor-box.png \
|
|
easing-modes.png \
|
|
event-flow.png \
|
|
path-alpha-func.png
|
|
|
|
# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
|
|
# e.g. content_files=running.sgml building.sgml changes-2.0.sgml
|
|
content_files= \
|
|
subclassing-ClutterActor.xml \
|
|
clutter-animation-tutorial.xml \
|
|
creating-behaviours.xml \
|
|
clutter-overview.xml \
|
|
building-clutter.xml \
|
|
running-clutter.xml
|
|
|
|
# SGML files where gtk-doc abbrevations (#GtkWidget) are expanded
|
|
# These files must be listed here *and* in content_files
|
|
# e.g. expand_content_files=running.sgml
|
|
expand_content_files= \
|
|
subclassing-ClutterActor.xml \
|
|
clutter-animation-tutorial.xml \
|
|
creating-behaviours.xml \
|
|
clutter-overview.xml \
|
|
building-clutter.xml \
|
|
running-clutter.xml
|
|
|
|
# CFLAGS and LDFLAGS for compiling gtkdoc-scangobj with your library.
|
|
# Only needed if you are using gtkdoc-scangobj to dynamically query widget
|
|
# signals and properties.
|
|
# e.g. INCLUDES=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
|
|
# e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib)
|
|
|
|
INCLUDES=-I$(top_srcdir) -I$(top_srcdir)/clutter $(CLUTTER_CFLAGS)
|
|
GTKDOC_LIBS=$(top_builddir)/clutter/libclutter-@CLUTTER_FLAVOUR@-@CLUTTER_MAJORMINOR@.la $(CLUTTER_LIBS)
|
|
|
|
# This includes the standard gtk-doc make rules, copied by gtkdocize.
|
|
include $(top_srcdir)/gtk-doc.make
|
|
|
|
# Other files to distribute
|
|
# e.g. EXTRA_DIST += version.xml.in
|
|
EXTRA_DIST += \
|
|
actor-box.png \
|
|
easing-modes.png \
|
|
easing-modes.svg \
|
|
event-flow.png \
|
|
path-alpha-func.png
|