From 2d297610d7531cd0c4d76fe5367b32278d9dd032 Mon Sep 17 00:00:00 2001 From: Gergely Polonkai Date: Mon, 26 Aug 2013 01:50:32 +0200 Subject: [PATCH] Cherry picked GTK-Doc related commits from swe-glib branch --- .gitignore | 20 +++++ Makefile.am | 4 +- configure.ac | 10 ++- docs/reference/astrognome/Makefile.am | 105 ++++++++++++++++++++++++++ 4 files changed, 134 insertions(+), 5 deletions(-) create mode 100644 docs/reference/astrognome/Makefile.am diff --git a/.gitignore b/.gitignore index ce6d43c..9ae7edb 100644 --- a/.gitignore +++ b/.gitignore @@ -37,3 +37,23 @@ Makefile.in /po/insert-header.sin /po/quot.sed /po/remove-potcdate.sin + +#Documentation related files +/docs/reference/*/*.args +/docs/reference/*/*.hierarchy +/docs/reference/*/*.interfaces +/docs/reference/*/*.prerequisites +/docs/reference/*/*.signals +/docs/reference/*/*.stamp +/docs/reference/*/*.types +/docs/reference/*/*-decl-list.txt +/docs/reference/*/*-decl.txt +/docs/reference/*/*-overrides.txt +/docs/reference/*/*-undeclared.txt +/docs/reference/*/*-docs.xml +/docs/reference/*/*-sections.txt +/docs/reference/*/*-undocumented.txt +/docs/reference/*/*-unused.txt +/docs/reference/*/xml/ +/docs/reference/*/html/ +/gtk-doc.make diff --git a/Makefile.am b/Makefile.am index 45314ca..1fc842c 100644 --- a/Makefile.am +++ b/Makefile.am @@ -1,4 +1,6 @@ ACLOCAL_AMFLAGS = -I m4 -SUBDIRS = swe/src src po +SUBDIRS = swe/src src po docs/reference/astrognome EXTRA_DIST = config.rpath m4/ChangeLog + +DISTCHECK_CONFIGURE_FLAGS = --enable-gtk-doc diff --git a/configure.ac b/configure.ac index 9ae09ee..ba3a022 100644 --- a/configure.ac +++ b/configure.ac @@ -35,6 +35,7 @@ AC_CHECK_LIB([m], [pow]) AC_CHECK_LIB([m], [log10]) AC_CHECK_LIB([m], [sqrt]) AC_CHECK_LIB([m], [floor]) +GTK_DOC_CHECK([1.19], [--flavour no-tmpl]) PKG_PROG_PKG_CONFIG PKG_CHECK_MODULES([GTK], [gtk+-3.0]) AC_CONFIG_MACRO_DIR([m4]) @@ -43,9 +44,10 @@ LIBSWE_LIBS='$(top_builddir)/swe/src/libswe-1.75.la' AC_SUBST(LIBSWE_LIBS) AC_CONFIG_FILES([ - Makefile - swe/src/Makefile - src/Makefile - po/Makefile.in + Makefile + swe/src/Makefile + src/Makefile + po/Makefile.in + docs/reference/astrognome/Makefile ]) AC_OUTPUT diff --git a/docs/reference/astrognome/Makefile.am b/docs/reference/astrognome/Makefile.am new file mode 100644 index 0000000..953eac6 --- /dev/null +++ b/docs/reference/astrognome/Makefile.am @@ -0,0 +1,105 @@ +## 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 +# of using the various options. + +# The name of the module, e.g. 'glib'. +DOC_MODULE=astrognome + +# Uncomment for versioned docs and specify the version of the module, e.g. '2'. +DOC_MODULE_VERSION=0 + + +# 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= + +# Extra options to supply to gtkdoc-scan. +# e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED" +SCAN_OPTIONS=--rebuild-sections --rebuild-types + +# Extra options to supply to gtkdoc-mkdb. +# 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= + +# 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= +CFILE_GLOB= + +# 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= + +# 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= + +# 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= +GTKDOC_LIBS=$(LIBSWE_LIBS) $(LIBSWE_GLIB_LIBS) + +# 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 += + +# 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 '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 + +-include $(top_srcdir)/git.mk