[dconf] Bug 597636 - gtk-docify dconf

[Ryan Lortie <ryanl src gnome org>]

commit cad895444a47d7106ec9c8e1278c300d70b0cc09
Author: Ryan Lortie <desrt desrt ca>
Date:   Wed Oct 7 01:22:08 2009 -0400

    Bug 597636 -  gtk-docify dconf

 Makefile.am                       |    4 ++-
 autogen.sh                        |    1 +
 configure.ac                      |    5 +++
 dconf/dconf.h                     |    4 +-
 docs/Makefile.am                  |    1 +
 docs/reference/.gitignore         |   17 ++++++++++++
 docs/reference/Makefile.am        |    8 ++++++
 docs/reference/dconf-docs.xml.in  |   30 ++++++++++++++++++++++
 docs/reference/dconf-sections.txt |   50 +++++++++++++++++++++++++++++++++++++
 9 files changed, 117 insertions(+), 3 deletions(-)
---
diff --git a/Makefile.am b/Makefile.am
index 15f7bd4..8aba66f 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -1,4 +1,6 @@
-SUBDIRS = common dconf bin writer service config
+DISTCHECK_CONFIGURE_FLAGS = --enable-gtk-doc
+
+SUBDIRS = common dconf bin writer service config docs
 
 if ENABLE_GIO
 SUBDIRS += gio
diff --git a/autogen.sh b/autogen.sh
index ec4e643..8a349ed 100755
--- a/autogen.sh
+++ b/autogen.sh
@@ -11,6 +11,7 @@ if [ "$1" = "clean" ]; then
 fi
 
 libtoolize --automake
+gtkdocize --docdir docs/reference --flavour no-tmpl
 aclocal
 automake --add-missing --foreign
 autoconf
diff --git a/configure.ac b/configure.ac
index 3405c22..545947b 100644
--- a/configure.ac
+++ b/configure.ac
@@ -6,6 +6,8 @@ AM_SILENT_RULES
 AC_PROG_LIBTOOL
 AC_PROG_CC
 
+GTK_DOC_CHECK
+
 PKG_CHECK_MODULES(glib, glib-2.0)
 PKG_CHECK_MODULES(dbus, dbus-1)
 
@@ -45,5 +47,8 @@ AC_OUTPUT([
   dconf/dconf.pc
   bin/Makefile
   gio/Makefile
+  docs/Makefile
+  docs/reference/Makefile
+  docs/reference/dconf-docs.xml
   Makefile
 ])
diff --git a/dconf/dconf.h b/dconf/dconf.h
index f1fc99c..d3a059e 100644
--- a/dconf/dconf.h
+++ b/dconf/dconf.h
@@ -33,8 +33,8 @@ gboolean                dconf_match                                     (const g
 GVariant *              dconf_get                                       (const gchar              *key);
 gchar **                dconf_list                                      (const gchar              *path,
                                                                          gint                     *length);
-gboolean                dconf_get_writable                              (const gchar              *path);
-gboolean                dconf_get_locked                                (const gchar              *path);
+gboolean                dconf_get_writable                              (const gchar              *key_or_path);
+gboolean                dconf_get_locked                                (const gchar              *key_or_path);
 
 
 
diff --git a/docs/Makefile.am b/docs/Makefile.am
new file mode 100644
index 0000000..f3ddc22
--- /dev/null
+++ b/docs/Makefile.am
@@ -0,0 +1 @@
+SUBDIRS = reference
diff --git a/docs/reference/.gitignore b/docs/reference/.gitignore
new file mode 100644
index 0000000..813a8b4
--- /dev/null
+++ b/docs/reference/.gitignore
@@ -0,0 +1,17 @@
+dconf-decl-list.txt
+dconf-decl.txt
+dconf-docs.xml
+dconf-overrides.txt
+dconf-undeclared.txt
+dconf-undocumented.txt
+dconf.args
+dconf.hierarchy
+dconf.interfaces
+dconf.prerequisites
+dconf.signals
+gtk-doc.make
+
+*.stamp
+html/
+xml/
+
diff --git a/docs/reference/Makefile.am b/docs/reference/Makefile.am
new file mode 100644
index 0000000..8728647
--- /dev/null
+++ b/docs/reference/Makefile.am
@@ -0,0 +1,8 @@
+include $(srcdir)/gtk-doc.make
+
+DOC_MODULE = dconf
+DOC_MAIN_SGML_FILE = dconf-docs.xml
+DOC_SOURCE_DIR = ../../dconf
+IGNORE_HFILES = dconf-private-types.h dconf-reader.h dconf-dbus.h
+MKDB_OPTIONS = --output-format=xml
+CLEANFILES += -r xml html *-overrides.txt *-decl.txt *-decl-list.txt
diff --git a/docs/reference/dconf-docs.xml.in b/docs/reference/dconf-docs.xml.in
new file mode 100644
index 0000000..63da2a5
--- /dev/null
+++ b/docs/reference/dconf-docs.xml.in
@@ -0,0 +1,30 @@
+<?xml version='1.0' encoding='utf-8'?>
+
+<!--
+
+    NOTE: dconf-docs.xml is auto-generated.
+          ensure that you edit the dconf-docs.xml.in file
+
+-->
+
+<book id='index' xmlns:xi='http://www.w3.org/2003/XInclude'>
+  <bookinfo>
+    <title>dconf Reference Manual</title>
+    <releaseinfo>
+      for dconf @PACKAGE_VERSION  
+      The latest version of this documentation can be found on-line at
+      <ulink role='online-location' url='http://library.gnome.org/devel/dconf/'
+        >http://library.gnome.org/devel/dconf/</ulink>.
+    </releaseinfo>
+  </bookinfo>
+
+  <chapter>
+    <title>Core API</title>
+    <xi:include href='xml/api.xml'/>
+  </chapter>
+
+  <index id='api-index-full'>
+    <title>API Index</title>
+    <xi:include href='xml/api-index-full.xml'><xi:fallback/></xi:include>
+  </index>
+</book>
diff --git a/docs/reference/dconf-sections.txt b/docs/reference/dconf-sections.txt
new file mode 100644
index 0000000..a8cd5a6
--- /dev/null
+++ b/docs/reference/dconf-sections.txt
@@ -0,0 +1,50 @@
+<SECTION>
+
+<FILE>dconf</FILE>
+DConfAsyncResult
+DConfAsyncReadyCallback
+DConfWatchFunc
+
+<SUBSECTION>
+dconf_is_key
+dconf_is_path
+dconf_is_key_or_path
+
+<SUBSECTION>
+dconf_match
+
+<SUBSECTION>
+dconf_get
+
+<SUBSECTION>
+dconf_list
+
+<SUBSECTION>
+dconf_get_writable
+dconf_get_locked
+
+<SUBSECTION>
+dconf_set
+dconf_set_async
+dconf_set_finish
+
+<SUBSECTION>
+dconf_set_locked
+dconf_set_locked_async
+dconf_set_locked_finish
+
+<SUBSECTION>
+dconf_reset
+dconf_reset_async
+dconf_reset_finish
+
+<SUBSECTION>
+dconf_merge
+dconf_merge_async
+dconf_merge_finish
+
+<SUBSECTION>
+dconf_watch
+dconf_unwatch
+
+</SECTION>