gtk-doc for libohm

Adds docs/reference/libohm with basic gtk-doc generation.

5 files changed, 91 insertions, 2 deletions

diff --git a/autogen.sh b/autogen.sh
index 323ceca..4f4a08d 100755
--- a/autogen.sh
+++ b/autogen.sh
@@ -28,7 +28,7 @@ $AUTOMAKE -a ohmd/Makefile || exit 1
 echo "Running gtkdocize..."
 gtkdocize || exit 1
 
-conf_flags=""
+conf_flags="--enable-gtk-doc"
 
 if test x$NOCONFIGURE = x; then
   echo Running $srcdir/configure $conf_flags "$@" ...
diff --git a/configure.in b/configure.in
index 06a32c3..7d81e01 100644
--- a/configure.in
+++ b/configure.in
@@ -325,6 +325,7 @@ docs/Makefile
 docs/index.xml
 docs/reference/Makefile
 docs/reference/ohm-plugin/Makefile
+docs/reference/libohm/Makefile
 libohm/Makefile
 libidletime/Makefile
 tools/Makefile
diff --git a/docs/reference/Makefile.am b/docs/reference/Makefile.am
index d1565fd..e11d2d0 100644
--- a/docs/reference/Makefile.am
+++ b/docs/reference/Makefile.am
@@ -1 +1 @@
-SUBDIRS = ohm-plugin
+SUBDIRS = ohm-plugin libohm
diff --git a/docs/reference/libohm/Makefile.am b/docs/reference/libohm/Makefile.am
new file mode 100644
index 0000000..ec58a3d
--- /dev/null
+++ b/docs/reference/libohm/Makefile.am
@@ -0,0 +1,78 @@
+## 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=libohm
+
+# The top-level SGML file. You can change this if you want to.
+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
+DOC_SOURCE_DIR=../../../libohm/
+
+# 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=
+
+# Extra options to supply to gtkdoc-mkdb.
+# e.g. MKDB_OPTIONS=--sgml-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-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)/libohm/*.h
+CFILE_GLOB=$(top_srcdir)/libohm/*.c
+
+# Header files to ignore when scanning.
+# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h
+IGNORE_HFILES= libohm-marshal.h
+
+# 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. INCLUDES=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
+# e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib)
+INCLUDES=-I$(top_srcdir) $(GLIB_CFLAGS)
+GTKDOC_LIBS=$(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 += 
diff --git a/docs/reference/libohm/libohm-docs.sgml b/docs/reference/libohm/libohm-docs.sgml
new file mode 100644
index 0000000..9f8a81c
--- /dev/null
+++ b/docs/reference/libohm/libohm-docs.sgml
@@ -0,0 +1,10 @@
+<?xml version="1.0"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
+               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
+<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
+  <bookinfo>
+    <title>LibOhm Reference Manual</title>
+  </bookinfo>
+
+  <xi:include href="xml/libohm.xml"/>
+</book>