[eog] Update gtk-doc Makefile template

[Felix Riemann <friemann src gnome org>]

commit b8b1314f7190863fca8c70f2682fc122b9f89357
Author: Felix Riemann <friemann gnome org>
Date:   Fri Oct 18 21:13:52 2013 +0200

    Update gtk-doc Makefile template
    
    Should fix an automake warning about deprecated variables.
    Raise required minimum version for XML parameter. It's probably also been
    a while since someone tested against gtk-doc 1.9.

 configure.ac                                       |    4 +-
 doc/reference/Makefile.am                          |   47 +++++++++++++------
 .../{eog-docs.sgml.in => eog-docs.xml.in}          |    0
 3 files changed, 34 insertions(+), 17 deletions(-)
---
diff --git a/configure.ac b/configure.ac
index ac12593..d6813d4 100644
--- a/configure.ac
+++ b/configure.ac
@@ -44,7 +44,7 @@ AC_PATH_PROG([GLIB_MKENUMS],[glib-mkenums])
 
 PKG_PROG_PKG_CONFIG
 
-GTK_DOC_CHECK(1.9)
+GTK_DOC_CHECK(1.16)
 
 AC_CHECK_FUNCS(strptime)
 
@@ -360,7 +360,7 @@ data/icons/scalable/Makefile
 doc/Makefile
 doc/reference/Makefile
 doc/reference/version.xml
-doc/reference/eog-docs.sgml
+doc/reference/eog-docs.xml
 plugins/Makefile
 ])
 
diff --git a/doc/reference/Makefile.am b/doc/reference/Makefile.am
index c960b03..036afcc 100644
--- a/doc/reference/Makefile.am
+++ b/doc/reference/Makefile.am
@@ -11,14 +11,18 @@ AUTOMAKE_OPTIONS = 1.6
 # The name of the module, e.g. 'glib'.
 DOC_MODULE=eog
 
-# The top-level SGML file. You can change this if you want to.
-DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml
+# Uncomment for versioned docs and specify the version of the module, e.g. '2'.
+#DOC_MODULE_VERSION=2
 
-# 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=../../src
+
+# The top-level XML file (SGML in the past). You can change this if you want to.
+DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.xml
+
+# Directories containing the source code.
+# gtk-doc will search all .c and .h files beneath these paths
+# for inline comments documenting functions and macros.
+# e.g. DOC_SOURCE_DIR=$(top_srcdir)/gtk $(top_srcdir)/gdk
+DOC_SOURCE_DIR=$(top_srcdir)/src
 
 # Extra options to pass to gtkdoc-scangobj. Not normally needed.
 SCANGOBJ_OPTIONS=
@@ -28,13 +32,16 @@ SCANGOBJ_OPTIONS=
 SCAN_OPTIONS=--rebuild-types
 
 # Extra options to supply to gtkdoc-mkdb.
-# e.g. MKDB_OPTIONS=--sgml-mode --output-format=xml
-MKDB_OPTIONS=--sgml-mode --output-format=xml
+# e.g. MKDB_OPTIONS=--xml-mode --output-format=xml
+MKDB_OPTIONS=--xml-mode --output-format=xml
 
 # Extra options to supply to gtkdoc-mktmpl
 # e.g. MKTMPL_OPTIONS=--only-section-tmpl
 MKTMPL_OPTIONS=
 
+# Extra options to supply to gtkdoc-mkhtml
+MKHTML_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=
@@ -45,8 +52,12 @@ FIXXREF_OPTIONS=
 HFILE_GLOB=$(top_srcdir)/src/*.h
 CFILE_GLOB=$(top_srcdir)/src/*.c
 
-# Header files to ignore when scanning.
-# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h
+# Extra header to include when scanning, which are not under DOC_SOURCE_DIR
+# e.g. EXTRA_HFILES=$(top_srcdir}/contrib/extra.h
+EXTRA_HFILES=
+
+# Header files or dirs to ignore when scanning. Use base file/dir names
+# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h private_code
 IGNORE_HFILES= \
        eog-image-private.h \
        eog-image-jpeg.h \
@@ -79,9 +90,9 @@ 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. INCLUDES=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
+# e.g. GTKDOC_CFLAGS=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
 # e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib)
-INCLUDES= \
+GTKDOC_CFLAGS= \
        -I$(top_srcdir)         \
        -I$(top_builddir)       \
        -I$(top_srcdir)/src     \
@@ -110,14 +121,20 @@ include $(top_srcdir)/gtk-doc.make
 # Other files to distribute
 # e.g. EXTRA_DIST += version.xml.in
 EXTRA_DIST += version.xml.in \
-             $(DOC_MODULE)-docs.sgml.in
+             $(DOC_MODULE)-docs.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 = $(DOC_MODULE).types
 
-# Comment this out if you want your docs-status tested during 'make check'
+# Comment this out if you want 'make check' to test you doc status
+# and run some sanity checks
+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
 
 -include $(top_srcdir)/git.mk
diff --git a/doc/reference/eog-docs.sgml.in b/doc/reference/eog-docs.xml.in
similarity index 100%
rename from doc/reference/eog-docs.sgml.in
rename to doc/reference/eog-docs.xml.in