[json-glib] build: Enable gtkdoc-check



commit 0f4a21d03a16ddd4cf052b9b2230ec004d05d430
Author: Emmanuele Bassi <ebassi gnome org>
Date:   Fri Mar 13 13:43:59 2015 +0000

    build: Enable gtkdoc-check
    
    We can verify that the documentation is correct and up to date every
    time we distcheck by turning on the gtk-doc check tool.

 .gitignore                |    3 +++
 doc/reference/Makefile.am |   24 ++++++++++--------------
 2 files changed, 13 insertions(+), 14 deletions(-)
---
diff --git a/.gitignore b/.gitignore
index 0485d11..53c477f 100644
--- a/.gitignore
+++ b/.gitignore
@@ -23,6 +23,9 @@ depcomp
 /doc/reference/version.xml
 /doc/reference/json-glib-format.1
 /doc/reference/json-glib-validate.1
+/doc/reference/json-glib.types
+/doc/reference/gtkdoc-check.*
+/doc/reference/test-suite.log
 gtk-doc.make
 install-sh
 json-glib-1.0.pc
diff --git a/doc/reference/Makefile.am b/doc/reference/Makefile.am
index 9342151..9650ce0 100644
--- a/doc/reference/Makefile.am
+++ b/doc/reference/Makefile.am
@@ -26,38 +26,34 @@ IGNORE_HFILES = \
 
 EXTRA_HFILES =
 
-# 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 = \
        json-glib-format.xml \
        json-glib-validate.xml \
        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. INCLUDES=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
-# e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib)
-
 AM_CPPFLAGS = -I$(top_srcdir) -I$(top_builddir) $(JSON_CFLAGS)
 GTKDOC_LIBS = $(top_builddir)/json-glib/libjson-glib-1.0.la $(JSON_LIBS)
 
-# This includes the standard gtk-doc make rules, copied by gtkdocize.
 include $(top_srcdir)/gtk-doc.make
 
 EXTRA_DIST += version.xml.in
 
 man_MANS =
 
+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
+
 if ENABLE_MAN
 man_MANS += \
        json-glib-format.1 \


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]