Modernise API docs

Use no-tmpl, move to xml, use xinclude, add indices.

1 files changed, 141 insertions, 60 deletions

diff --git a/doc/Makefile.am b/doc/Makefile.am
index 8674ef36..c53e607f 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -1,69 +1,150 @@
-## Process this file with automake to produce Makefile.in
+# We require automake 1.10 for $(abs_builddir)
+AUTOMAKE_OPTIONS = 1.10
 
-# The name of the module.
-DOC_MODULE=rsvg
+# 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 = rsvg
 
 # Uncomment for versioned docs and specify the version of the module, e.g. '2'.
 DOC_MODULE_VERSION = $(RSVG_API_VERSION)
 
-# The top-level SGML file.
-DOC_MAIN_SGML_FILE=rsvg-docs.sgml
-
-# The directory containing the source code. Relative to $(srcdir)
-DOC_SOURCE_DIR=..
-
-# Extra options to pass to gtkdoc-scangobj
-SCANGOBJ_OPTIONS= --nogtkinit --type-init-func="g_type_init ()" 
-
-# Extra options to supply to gtkdoc-scan
-SCAN_OPTIONS=--deprecated-guards=RSVG_DISABLE_DEPRECATED
-
-# Extra options to supply to gtkdoc-mkdb
-MKDB_OPTIONS= --sgml-mode --output-format=xml
-
-# Extra options to supply to gtkdoc-fixref
-FIXXREF_OPTIONS=
-
-# Used for dependencies
-HFILE_GLOB=$(top_srcdir)/*.h
-CFILE_GLOB=$(top_srcdir)/*.c
-
-# Header files to ignore when scanning
-IGNORE_HFILES= \
-	config.h		\
-	librsvg-features.h	\
-	rsvg-bpath-util.h	\
-	rsvg-css.h		\
-	rsvg-defs.h		\
-	rsvg-paint-server.h	\
-	rsvg-path.h		\
-	rsvg-private.h		\
-	rsvg-shapes.h		\
-	rsvg-styles.h		\
-	rsvg-text.h		\
-	svg-rc-style.h		\
-	svg-style.h		\
-	svg.h
 
-# Images to copy into HTML directory
-HTML_IMAGES=
-
-EXTRA_HFILES=
-
-# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE)
-content_files=
+# 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 = ..
+
+# Extra options to pass to gtkdoc-scangobj. Not normally needed.
+SCANGOBJ_OPTIONS = --nogtkinit --type-init-func="g_type_init ()"
+
+# Extra options to supply to gtkdoc-scan.
+# e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED"
+SCAN_OPTIONS = --deprecated-guards="RSVG_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=rsvg
+
+# Extra options to supply to gtkdoc-mktmpl
+# e.g. MKTMPL_OPTIONS=--only-section-tmpl
+MKTMPL_OPTIONS =
+
+# Extra options to supply to gtkdoc-mkhtml
+# Add the builddir to the HTML path so that version.xml is found
+MKHTML_OPTIONS = --path="$(abs_builddir)"
+
+# 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/glib \
+	--extra-dir=$(GLIB_PREFIX)/share/gtk-doc/html/gio \
+	--extra-dir=$(GTK_PREFIX)/share/gtk-doc/html/gdk \
+	--extra-dir=$(GTK_PREFIX)/share/gtk-doc/html/gdk-pixbuf \
+	--extra-dir=$(CAIRO_PREFIX)/share/gtk-doc/html/cairo
+
+# 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)/*.h \
+	$(top_builddir)/*.h
+
+CFILE_GLOB = \
+	$(top_srcdir)/*.c \
+	$(top_builddir)/*.c
+
+# Extra header to include when scanning, which are not under DOC_SOURCE_DIR
+# e.g. EXTRA_HFILES=$(top_srcdir}/contrib/extra.h
+# EXTRA_HFILES = $(top_builddir)/evdocument/ev-version.h
+EXTRA_HFILES =
+
+# Header files to ignore when scanning. Use base file name, no paths
+# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h
+IGNORE_HFILES = \
+	config.h \
+	rsvg-bpath-util.h \
+	rsvg-cairo-clip.h \
+	rsvg-cairo-draw.h \
+	rsvg-cairo-render.h \
+	rsvg-css.h \
+	rsvg-defs.h \
+	rsvg-filter.h \
+	rsvg-image.h \
+	rsvg-marker.h \
+	rsvg-mask.h \
+	rsvg-paint-server.h \
+	rsvg-path.h \
+	rsvg-private.h \
+	rsvg-shapes.h \
+	rsvg-structure.h \
+	rsvg-styles.h \
+	rsvg-text.h \
+	rsvg-xml.h
+
+# Images to copy into HTML directory.
+# e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png
+HTML_IMAGES =
+
+# 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 = \
+ 	version.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 =
+
+# 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. GTKDOC_CFLAGS=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
+# e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib)
+GTKDOC_CFLAGS = \
+	-I$(top_srcdir) \
+	-I$(top_builddir) \
+	$(LIBRSVG_CFLAGS) \
+	$(LIBGSF_CFLAGS) \
+	$(LIBCROCO_CFLAGS) \
+	$(GTK_CFLAGS) \
+	$(GDK_X11_CFLAGS) \
+	$(WARN_CFLAGS) \
+	$(DISABLE_DEPRECATED) \
+	$(AM_CFLAGS)
+
+GTKDOC_LIBS = \
+	$(top_builddir)/librsvg-@RSVG_API_MAJOR_VERSION@.la \
+	$(LIBRSVG_LIBS) \
+	$(LIBGSF_LIBS) \
+	$(GLIB_LIBS) \
+	$(LIBCROCO_LIBS) \
+	$(GTK_LIBS)
+
+# This includes the standard gtk-doc make rules, copied by gtkdocize.
+include $(top_srcdir)/gtk-doc.make
 
 # Other files to distribute
-extra_files=
-
-# CFLAGS and LDFLAGS for compiling scan program. Only needed
-# if $(DOC_MODULE).types is non-empty.
-GTKDOC_CFLAGS = -I$(top_srcdir) $(LIBRSVG_CFLAGS)
-
-GTKDOC_LIBS = $(top_builddir)/librsvg-@RSVG_API_MAJOR_VERSION@.la $(LIBRSVG_LIBS)
-
-if GTK_DOC_INSTALLED
-include $(top_srcdir)/gtk-doc.make
-CLEANFILES += rsvg-scan.*
-.PHONY : dist-hook-local
+# e.g. EXTRA_DIST += version.xml.in
+EXTRA_DIST += \
+	version.xml.in
+
+# Files not to distribute
+# for --rebuild-types in $(SCAN_OPTIONS), e.g. $(DOC_MODULE).types
+# for --rebuild-sections in $(SCAN_OPTIONS) e.g. $(DOC_MODULE)-sections.txt
+#DISTCLEANFILES +=
+
+# Comment this out if you want your docs-status tested during 'make check'
+if ENABLE_GTK_DOC
+#TESTS_ENVIRONMENT = cd $(srcsrc) &&
+#TESTS = $(GTKDOC_CHECK)
 endif
+
+-include $(top_srcdir)/git.mk