Permalink
Browse files

initial gtk-doc setup

  • Loading branch information...
1 parent b4465e6 commit 471faa392a180b5fd4ae23cf15ffdddb4673d88a William Hua committed Nov 20, 2010
Showing with 151 additions and 2 deletions.
  1. +2 −0 .gitignore
  2. +5 −1 Makefile.am
  3. +9 −0 autogen.sh
  4. +11 −1 configure.ac
  5. +1 −0 docs/Makefile.am
  6. +18 −0 docs/reference/.gitignore
  7. +105 −0 docs/reference/Makefile.am
View
@@ -10,7 +10,9 @@ config.status
config.sub
configure
depcomp
+gtk-doc.make
install-sh
libtool
ltmain.sh
+m4
missing
View
@@ -1,4 +1,8 @@
-SUBDIRS = src
+SUBDIRS = src docs
+
+ACLOCAL_AMFLAGS = -I m4
pkgconfig_DATA = clutter-bullet.pc
pkgconfigdir = $(libdir)/pkgconfig
+
+DISTCHECK_CONFIGURE_FLAGS = --enable-gtk-doc --enable-gtk-doc-html --enable-gtk-doc-pdf
View
@@ -5,11 +5,19 @@ CRAP="aclocal.m4
config.sub
configure
depcomp
+ gtk-doc.make
INSTALL
install-sh
ltmain.sh
+ m4
Makefile.in
missing
+ docs/Makefile.in
+ docs/reference/clutter-bullet-docs.sgml
+ docs/reference/clutter-bullet-overrides.txt
+ docs/reference/clutter-bullet-sections.txt
+ docs/reference/clutter-bullet.types
+ docs/reference/Makefile.in
src/config.h.in
src/Makefile.in"
@@ -20,6 +28,7 @@ if [ "$1" = "clean" ]; then
fi
libtoolize
+gtkdocize --flavour no-tmpl
aclocal
autoconf
View
@@ -13,6 +13,7 @@ LT_INIT
AC_CONFIG_SRCDIR([src/clutter-bullet.h])
AM_CONFIG_HEADER([src/config.h])
+AC_CONFIG_MACRO_DIR(m4)
AC_PROG_CC
AC_PROG_CXX
@@ -31,12 +32,21 @@ PKG_CHECK_MODULES([CLUTTER], [clutter-$CLUTTER_API_VERSION >= $CLUTTER_VERSION])
AC_SUBST([CLUTTER_CFLAGS])
AC_SUBST([CLUTTER_LIBS])
+GTK_DOC_CHECK([1.14], [--flavour no-tmpl])
+
# checks for header files
# checks for types
# checks for structures
# checks for compiler characteristics
# checks for library functions
# checks for system services
-AC_CONFIG_FILES([clutter-bullet.pc Makefile src/Makefile])
+AC_CONFIG_FILES([
+ clutter-bullet.pc
+ Makefile
+ docs/Makefile
+ docs/reference/Makefile
+ src/Makefile
+])
+
AC_OUTPUT
View
@@ -0,0 +1 @@
+SUBDIRS = reference
View
@@ -0,0 +1,18 @@
+*.stamp
+.libs
+clutter-bullet-decl-list.txt
+clutter-bullet-decl.txt
+clutter-bullet-docs.sgml
+clutter-bullet-overrides.txt
+clutter-bullet-sections.txt
+clutter-bullet-undeclared.txt
+clutter-bullet-undocumented.txt
+clutter-bullet-unused.txt
+clutter-bullet.args
+clutter-bullet.hierarchy
+clutter-bullet.interfaces
+clutter-bullet.prerequisites
+clutter-bullet.signals
+clutter-bullet.types
+html
+xml
View
@@ -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 = clutter-bullet
+
+# Uncomment for versioned docs and specify the version of the module, e.g. '2'.
+#DOC_MODULE_VERSION = 2
+
+# The top-level SGML file. You can change this if you want to.
+DOC_MAIN_SGML_FILE = $(DOC_MODULE)-docs.sgml
+
+# Directories containing the source code, relative to $(srcdir).
+# gtk-doc will search all .c and .h files beneath these paths
+# for inline comments documenting functions and macros.
+# e.g. DOC_SOURCE_DIR=../../../gtk ../../../gdk
+DOC_SOURCE_DIR = ../../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 = --deprecated-guards="CLUTTER_BULLET_DISABLE_DEPRECATED"
+
+# 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 = $(top_srcdir)/src/*.h
+CFILE_GLOB = $(top_srcdir)/src/*.c \
+ $(top_srcdir)/src/*.cc
+
+# 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 to ignore when scanning. Use base file name, no paths
+# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h
+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 = $(BULLET_CFLAGS) $(CLUTTER_CFLAGS)
+GTKDOC_LIBS = $(top_builddir)/src/libclutter-bullet.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 +=
+
+# 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

0 comments on commit 471faa3

Please sign in to comment.