GNOME.org
 

[goocanvas] support latest gtk-doc and add an index. #788436

commit f2989089ee5e27efbf9234ee1bb7453d958c709a
Author: Damon Chaplin <Damon A Chaplin gmail com>
Date:   Tue Oct 10 10:38:06 2017 +0100

    support latest gtk-doc and add an index. #788436

 .gitignore                |    1 +
 ChangeLog                 |    7 ++++
 configure.in              |    2 +-
 docs/Makefile.am          |   71 ++++++++++++++++++++++++--------------------
 docs/goocanvas3-docs.sgml |   10 ++++++
 5 files changed, 58 insertions(+), 33 deletions(-)
---
diff --git a/.gitignore b/.gitignore
index fd25ad2..618498f 100644
--- a/.gitignore
+++ b/.gitignore
@@ -67,6 +67,7 @@ Makefile.in
 /src/GooCanvas-[23].0.gir
 /src/GooCanvas-[23].0.typelib
 /stamp-h1
+/test-driver
 /docs/goocanvas-decl-list.txt
 /docs/goocanvas-decl.txt
 /docs/goocanvas-undeclared.txt
diff --git a/ChangeLog b/ChangeLog
index 0a022af..c98cc40 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,10 @@
+2017-10-09  Damon Chaplin  <damon gnome org>
+
+       * docs/goocanvas2-docs.sgml:
+       * docs/Makefile.am:
+       * configure.in: patch from Ross Gammon to support latest gtk-doc
+       and add an index. #788436
+
 2017-08-30  Damon Chaplin  <damon gnome org>
 
        * src/goocanvas.c: If we receive a LEAVE_NOTIFY event with a mode of
diff --git a/configure.in b/configure.in
index fd96018..86d774c 100644
--- a/configure.in
+++ b/configure.in
@@ -107,7 +107,7 @@ fi
 
 AM_CONDITIONAL(ENABLE_PYTHON, test x"$enable_python" = "xyes")
 
-GTK_DOC_CHECK(1.8)
+GTK_DOC_CHECK(1.16)
 
 AC_OUTPUT([
 Makefile
diff --git a/docs/Makefile.am b/docs/Makefile.am
index c634e74..453e0bc 100644
--- a/docs/Makefile.am
+++ b/docs/Makefile.am
@@ -1,8 +1,3 @@
-## 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
@@ -11,31 +6,33 @@ AUTOMAKE_OPTIONS = 1.6
 # The name of the module, e.g. 'glib'.
 DOC_MODULE=goocanvas3
 
-# The top-level SGML file. You can change this if you want to.
+# Uncomment for versioned docs and specify the version of the module, e.g. '2'.
+#DOC_MODULE_VERSION=2
+
+# The top-level XML file.
 DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml
 
-# 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
+# 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=../src
 
-# Extra options to pass to gtkdoc-scangobj. Not normally needed.
+# Extra options to pass to gtkdoc-scangobj. Normally not needed.
 SCANGOBJ_OPTIONS=--query-child-properties=goo_canvas_query_child_properties
 
 # Extra options to supply to gtkdoc-scan.
-# e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED" 
+# e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED"
 SCAN_OPTIONS=
 
-# Extra options to supply to gtkdoc-mkdb.
-# e.g. MKDB_OPTIONS=--sgml-mode --output-format=xml
+# Extra options to supply to gtkdoc-mkdb
+# e.g. MKDB_OPTIONS=--xml-mode --output-format=xml
 MKDB_OPTIONS=--sgml-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.
+# Extra options to supply to gtkdoc-fixref. Normally not needed.
 # e.g. FIXXREF_OPTIONS=--extra-dir=../gdk-pixbuf/html --extra-dir=../gdk/html
 FIXXREF_OPTIONS=
 
@@ -45,17 +42,24 @@ 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=goocanvasmarshal.h goocanvasprivate.h
 
 # Images to copy into HTML directory.
 # e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png
 HTML_IMAGES=
 
-# 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
+# Extra files that are included by $(DOC_MAIN_SGML_FILE).
+# e.g. content_files=running.xml building.xml changes-2.0.xml
+content_files= $(expand_content_files)
+
+# Files where gtk-doc abbrevations (#GtkWidget) are expanded
+# e.g. expand_content_files=running.xml
 expand_content_files=                          \
        overview.xml                            \
        simple-canvas.xml                       \
@@ -65,21 +69,24 @@ expand_content_files=                               \
        coordinates.xml                         \
        creating-items.xml
 
-# 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= $(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=-I$(top_srcdir)/src -I$(top_builddir)/src @PACKAGE_CFLAGS@
+GTKDOC_CFLAGS=-I$(top_srcdir)/src -I$(top_builddir)/src @PACKAGE_CFLAGS@
 GTKDOC_LIBS=@PACKAGE_LIBS@ $(top_builddir)/src/libgoocanvas-3.0.la
 
 # 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 += 
+# 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/docs/goocanvas3-docs.sgml b/docs/goocanvas3-docs.sgml
index d7a4c64..48ad0ac 100644
--- a/docs/goocanvas3-docs.sgml
+++ b/docs/goocanvas3-docs.sgml
@@ -59,4 +59,14 @@
     <xi:include href="xml/goocanvasutils.xml"/>
     <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
   </chapter>
+
+  <index id="api-index-full">
+    <title>API Index</title>
+    <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
+  </index>
+  <index id="deprecated-api-index" role="deprecated">
+    <title>Index of deprecated API</title>
+    <xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
+  </index>
+
 </book>
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]