aboutsummaryrefslogtreecommitdiff
path: root/docs/reference
diff options
context:
space:
mode:
authorMathieu Trudel-Lapierre <mathieu-tl@ubuntu.com>2012-12-10 17:00:06 -0500
committerMathieu Trudel-Lapierre <mathieu-tl@ubuntu.com>2012-12-10 17:00:06 -0500
commitc8d15b03fbbff63e544f5422e57e86fe174e9325 (patch)
tree15787b8545d068076ab8a4b95556535f7f42b894 /docs/reference
parent06056540ac3d9f8f11d13bb9d5cb6a5f8d62584d (diff)
parenteffd665a42d8cd01fd72549150fb1fd029ad8d3f (diff)
downloadlibayatana-appindicator-c8d15b03fbbff63e544f5422e57e86fe174e9325.tar.gz
libayatana-appindicator-c8d15b03fbbff63e544f5422e57e86fe174e9325.tar.bz2
libayatana-appindicator-c8d15b03fbbff63e544f5422e57e86fe174e9325.zip
Fix gtkdoc tests and building of the documentation given a separate build
directory.
Diffstat (limited to 'docs/reference')
-rw-r--r--docs/reference/Makefile.am22
-rw-r--r--docs/reference/tmpl/libappindicator-unused.sgml42
2 files changed, 10 insertions, 54 deletions
diff --git a/docs/reference/Makefile.am b/docs/reference/Makefile.am
index 8f87b34..2c201bd 100644
--- a/docs/reference/Makefile.am
+++ b/docs/reference/Makefile.am
@@ -30,7 +30,7 @@ DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml
# 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
+DOC_SOURCE_DIR=$(top_srcdir)/src
# Extra options to pass to gtkdoc-scangobj. Not normally needed.
SCANGOBJ_OPTIONS=--nogtkinit --type-init-func="g_type_init()"
@@ -102,7 +102,7 @@ GTKDOC_CFLAGS=-I$(top_srcdir) -I$(top_srcdir)/src -I$(top_srcdir)/src $(LIBRARY_
GTKDOC_LIBS=$(top_builddir)/src/$(APPINDICATORLIB) $(LIBRARY_LIBS)
# This includes the standard gtk-doc make rules, copied by gtkdocize.
-include $(top_srcdir)/gtk-doc.local.make
+include $(top_srcdir)/gtk-doc.make
# Other files to distribute
# e.g. EXTRA_DIST += version.xml.in
@@ -113,13 +113,11 @@ EXTRA_DIST += version.xml.in libappindicator-docs.sgml.in
# 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'
-TESTS = gtkdoc-in-srcdir
-
-gtkdoc-in-srcdir: Makefile.am
- @echo "#!/bin/sh" > $@
- @echo "cd \"$(srcdir)\"" >> $@
- @echo "$(GTKDOC_CHECK)" >> $@
- @chmod +x $@
-DISTCLEANFILES = gtkdoc-in-srcdir
-
+# Comment this out if you want 'make check' to test you doc status
+# and run some sanity checks
+if ENABLE_GTK_DOC
+ TESTS_ENVIRONMENT = cd $(srcdir) && \
+ DOC_MODULE=$(DOC_MODULE) DOC_MAIN_SGML_FILE=$(DOC_MAIN_SGML_FILE) \
+ SRCDIR=$(abs_srcdir) BUILDDIR=$(abs_builddir)
+TESTS = $(GTKDOC_CHECK)
+endif
diff --git a/docs/reference/tmpl/libappindicator-unused.sgml b/docs/reference/tmpl/libappindicator-unused.sgml
deleted file mode 100644
index 789a03f..0000000
--- a/docs/reference/tmpl/libappindicator-unused.sgml
+++ /dev/null
@@ -1,42 +0,0 @@
-<!-- ##### MACRO APP_INDICATOR_SIGNAL_NEW_ACCESSIBLE_DESC ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### SIGNAL AppIndicator::new-accessible-desc ##### -->
-<para>
-
-</para>
-
-@appindicator: the object which received the signal.
-@arg1:
-
-<!-- ##### ARG AppIndicator:accessible-desc ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### ARG AppIndicator:icon-path ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### FUNCTION app_indicator_get_accessible_desc ##### -->
-<para>
-
-</para>
-
-@self:
-@Returns:
-
-<!-- ##### FUNCTION app_indicator_set_accessible_desc ##### -->
-<para>
-
-</para>
-
-@self:
-@accessible_desc:
-