add gtk-doc framework and fix up docs everywhere

(Old svn revision: 26717)

11 files changed, 627 insertions, 0 deletions

diff --git a/docs/Makefile.am b/docs/Makefile.am
new file mode 100644
index 0000000..74e86fd
--- /dev/null
+++ b/docs/Makefile.am
@@ -0,0 +1,2 @@
+SUBDIRS = \
+	reference
diff --git a/docs/reference/Makefile.am b/docs/reference/Makefile.am
new file mode 100644
index 0000000..e246771
--- /dev/null
+++ b/docs/reference/Makefile.am
@@ -0,0 +1,76 @@
+## Process this file with automake to produce Makefile.in
+
+AUTOMAKE_OPTIONS = 1.8
+
+# The name of the module.
+DOC_MODULE=xfconf
+
+# The top-level SGML file.
+DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml
+
+# Extra options to supply to gtkdoc-scan
+SCAN_OPTIONS=--deprecated-guards="XFCE_DISABLE_DEPRECATED"
+
+# The directory containing the source code. Relative to $(srcdir)
+DOC_SOURCE_DIR=../..
+
+# Extra options to supply to gtkdoc-mkdb
+MKDB_OPTIONS=--sgml-mode --output-format=xml
+
+# Extra options to supply to gtkdoc-fixref
+FIXXREF_OPTIONS=
+
+# Used for dependencies
+HFILE_GLOB=$(top_srcdir)/xfconf/*.h $(top_srcdir)/xfconfd/*.h
+CFILE_GLOB=$(top_srcdir)/xfconf/*.c $(top_srcdir)/xfconfd/*.c
+
+# Header files to ignore when scanning
+IGNORE_HFILES= \
+	config.h \
+	xfconf-backend-factory.h \
+	xfconf-backend-perchannel-xml.h \
+	xfconf-daemon.h \
+	xfconf-dbus-bindings.h \
+	xfconf-marshal.h \
+	xfconf-private.h \
+	xfconfd-dbus-server.h
+
+# Extra files to add when scanning (relative to $srcdir)
+EXTRA_HFILES=
+
+# Images to copy into HTML directory
+HTML_IMAGES = 
+
+# Extra SGML files that are included by DOC_MAIN_SGML_FILE
+content_files = \
+	version.xml
+
+# CFLAGS and LDFLAGS for compiling scan program. Only needed
+# if $(DOC_MODULE).types is non-empty.
+INCLUDES = \
+	-I$(top_srcdir) \
+	-I$(top_builddir) \
+	$(GLIB_CFLAGS) \
+	$(LIBXFCE4UTIL_CFLAGS) \
+	$(DBUS_CFLAGS) \
+	$(DBUS_GLIB_CFLAGS)
+
+GTKDOC_LIBS = \
+	$(top_builddir)/xfconf/libxfconf-$(LIBXFCONF_VERSION_API).la \
+	$(top_builddir)/xfconfd/xfconfd-xfconf-backend.o
+
+include $(top_srcdir)/gtk-doc.make
+
+# Other files to distribute
+EXTRA_DIST += \
+	version.xml.in
+
+# manual pages
+man_MANS =
+
+if MAINTAINER_MODE
+%.1: %.xml
+	xsltproc -nonet http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl $<
+endif
+
+# vi:set ts=8 sw=8 noet ai nocindent syntax=automake:
diff --git a/docs/reference/tmpl/xfconf-backend.sgml b/docs/reference/tmpl/xfconf-backend.sgml
new file mode 100644
index 0000000..c37a6cb
--- /dev/null
+++ b/docs/reference/tmpl/xfconf-backend.sgml
@@ -0,0 +1,130 @@
+<!-- ##### SECTION Title ##### -->
+XfconfBackend
+
+<!-- ##### SECTION Short_Description ##### -->
+Interface for configuration store backends
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+XfconfBackend is an abstract interface that allows the Xfconf Daemon
+to use different backends for storing configuration data.  These backends
+can be flat text or binary files, a database, or just about anything
+one could think of to store data.
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION Stability_Level ##### -->
+
+
+<!-- ##### MACRO XFCONF_BACKEND_ERROR ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### STRUCT XfconfBackendInterface ##### -->
+<para>
+
+</para>
+
+@parent: GObject interface parent.
+@initialize: See xfconf_backend_initialize().
+@set: See xfconf_backend_set().
+@get: See xfconf_backend_get().
+@get_all: See xfconf_backend_get_all().
+@exists: See xfconf_backend_exists().
+@remove: See xfconf_backend_remove().
+@flush: See xfconf_backend_flush().
+@_xb_reserved0: Reserved for future expansion.
+@_xb_reserved1: Reserved for future expansion.
+@_xb_reserved2: Reserved for future expansion.
+@_xb_reserved3: Reserved for future expansion.
+
+<!-- ##### FUNCTION xfconf_backend_initialize ##### -->
+<para>
+
+</para>
+
+@backend: 
+@error: 
+@Returns: 
+
+
+<!-- ##### FUNCTION xfconf_backend_set ##### -->
+<para>
+
+</para>
+
+@backend: 
+@channel: 
+@property: 
+@value: 
+@error: 
+@Returns: 
+
+
+<!-- ##### FUNCTION xfconf_backend_get ##### -->
+<para>
+
+</para>
+
+@backend: 
+@channel: 
+@property: 
+@value: 
+@error: 
+@Returns: 
+
+
+<!-- ##### FUNCTION xfconf_backend_get_all ##### -->
+<para>
+
+</para>
+
+@backend: 
+@channel: 
+@properties: 
+@error: 
+@Returns: 
+
+
+<!-- ##### FUNCTION xfconf_backend_exists ##### -->
+<para>
+
+</para>
+
+@backend: 
+@channel: 
+@property: 
+@exists: 
+@error: 
+@Returns: 
+
+
+<!-- ##### FUNCTION xfconf_backend_remove ##### -->
+<para>
+
+</para>
+
+@backend: 
+@channel: 
+@property: 
+@error: 
+@Returns: 
+
+
+<!-- ##### FUNCTION xfconf_backend_flush ##### -->
+<para>
+
+</para>
+
+@backend: 
+@error: 
+@Returns: 
+
+
diff --git a/docs/reference/tmpl/xfconf-channel.sgml b/docs/reference/tmpl/xfconf-channel.sgml
new file mode 100644
index 0000000..69f5b25
--- /dev/null
+++ b/docs/reference/tmpl/xfconf-channel.sgml
@@ -0,0 +1,210 @@
+<!-- ##### SECTION Title ##### -->
+XfconfChannel
+
+<!-- ##### SECTION Short_Description ##### -->
+An application-defined domain for storing configuration settings
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+An XfconfChannel is a representation of a restricted domain or
+namespace that an application can define to store configuration
+settings.  This is to ensure that different applications do not store
+configuration keys with the same names.
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION Stability_Level ##### -->
+
+
+<!-- ##### STRUCT XfconfChannel ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### SIGNAL XfconfChannel::property-changed ##### -->
+<para>
+
+</para>
+
+@xfconfchannel: the object which received the signal.
+@arg1: 
+
+<!-- ##### ARG XfconfChannel:channel-name ##### -->
+<para>
+
+</para>
+
+<!-- ##### FUNCTION xfconf_channel_new ##### -->
+<para>
+
+</para>
+
+@channel_name: 
+@Returns: 
+
+
+<!-- ##### FUNCTION xfconf_channel_has_property ##### -->
+<para>
+
+</para>
+
+@channel: 
+@property: 
+@Returns: 
+
+
+<!-- ##### FUNCTION xfconf_channel_remove_property ##### -->
+<para>
+
+</para>
+
+@channel: 
+@property: 
+
+
+<!-- ##### FUNCTION xfconf_channel_get_all ##### -->
+<para>
+
+</para>
+
+@channel: 
+@Returns: 
+
+
+<!-- ##### FUNCTION xfconf_channel_get_string ##### -->
+<para>
+
+</para>
+
+@channel: 
+@property: 
+@default_value: 
+@Returns: 
+
+
+<!-- ##### FUNCTION xfconf_channel_get_string_list ##### -->
+<para>
+
+</para>
+
+@channel: 
+@property: 
+@default_value: 
+@Returns: 
+
+
+<!-- ##### FUNCTION xfconf_channel_get_int ##### -->
+<para>
+
+</para>
+
+@channel: 
+@property: 
+@default_value: 
+@Returns: 
+
+
+<!-- ##### FUNCTION xfconf_channel_get_int64 ##### -->
+<para>
+
+</para>
+
+@channel: 
+@property: 
+@default_value: 
+@Returns: 
+
+
+<!-- ##### FUNCTION xfconf_channel_get_double ##### -->
+<para>
+
+</para>
+
+@channel: 
+@property: 
+@default_value: 
+@Returns: 
+
+
+<!-- ##### FUNCTION xfconf_channel_get_bool ##### -->
+<para>
+
+</para>
+
+@channel: 
+@property: 
+@default_value: 
+@Returns: 
+
+
+<!-- ##### FUNCTION xfconf_channel_set_string ##### -->
+<para>
+
+</para>
+
+@channel: 
+@property: 
+@value: 
+@Returns: 
+
+
+<!-- ##### FUNCTION xfconf_channel_set_string_list ##### -->
+<para>
+
+</para>
+
+@channel: 
+@property: 
+@value: 
+@Returns: 
+
+
+<!-- ##### FUNCTION xfconf_channel_set_int ##### -->
+<para>
+
+</para>
+
+@channel: 
+@property: 
+@value: 
+@Returns: 
+
+
+<!-- ##### FUNCTION xfconf_channel_set_int64 ##### -->
+<para>
+
+</para>
+
+@channel: 
+@property: 
+@value: 
+@Returns: 
+
+
+<!-- ##### FUNCTION xfconf_channel_set_double ##### -->
+<para>
+
+</para>
+
+@channel: 
+@property: 
+@value: 
+@Returns: 
+
+
+<!-- ##### FUNCTION xfconf_channel_set_bool ##### -->
+<para>
+
+</para>
+
+@channel: 
+@property: 
+@value: 
+@Returns: 
+
+
diff --git a/docs/reference/tmpl/xfconf-unused.sgml b/docs/reference/tmpl/xfconf-unused.sgml
new file mode 100644
index 0000000..157b816
--- /dev/null
+++ b/docs/reference/tmpl/xfconf-unused.sgml
@@ -0,0 +1,91 @@
+<!-- ##### SECTION ./tmpl/config.sgml:Long_Description ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### SECTION ./tmpl/config.sgml:See_Also ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### SECTION ./tmpl/config.sgml:Short_Description ##### -->
+
+
+
+<!-- ##### SECTION ./tmpl/config.sgml:Stability_Level ##### -->
+
+
+
+<!-- ##### SECTION ./tmpl/config.sgml:Title ##### -->
+config
+
+
+<!-- ##### SECTION ./tmpl/stamp-xfconf-marshal.sgml:Long_Description ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### SECTION ./tmpl/stamp-xfconf-marshal.sgml:See_Also ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### SECTION ./tmpl/stamp-xfconf-marshal.sgml:Short_Description ##### -->
+
+
+
+<!-- ##### SECTION ./tmpl/stamp-xfconf-marshal.sgml:Stability_Level ##### -->
+
+
+
+<!-- ##### SECTION ./tmpl/stamp-xfconf-marshal.sgml:Title ##### -->
+stamp-xfconf-marshal
+
+
+<!-- ##### MACRO XFCONF_BACKEND_GET_INTERFACE ##### -->
+<para>
+
+</para>
+
+@obj: 
+
+<!-- ##### STRUCT XfconfBackend ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### FUNCTION xfconf_backend_get_error_quark ##### -->
+<para>
+
+</para>
+
+@Returns: 
+
+<!-- ##### FUNCTION xfconf_channel_begin_transaction ##### -->
+<para>
+
+</para>
+
+@channel: 
+@Returns: 
+
+<!-- ##### FUNCTION xfconf_channel_cancel_transaction ##### -->
+<para>
+
+</para>
+
+@channel: 
+
+<!-- ##### FUNCTION xfconf_channel_commit_transaction ##### -->
+<para>
+
+</para>
+
+@channel: 
+@Returns: 
+
diff --git a/docs/reference/tmpl/xfconf.sgml b/docs/reference/tmpl/xfconf.sgml
new file mode 100644
index 0000000..5d63af8
--- /dev/null
+++ b/docs/reference/tmpl/xfconf.sgml
@@ -0,0 +1,40 @@
+<!-- ##### SECTION Title ##### -->
+Xfconf Library Initialization
+
+<!-- ##### SECTION Short_Description ##### -->
+Init routines for libxfconf
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+Before libxfconf can be used, it must be initialized by calling
+xfconf_init().  To free resources used by the library, call
+xfconf_shutdown().  These calls are "recursive": multiple calls to
+xfconf_init() are allowed, but each call must be matched by a
+separate call to xfconf_shutdown() to really free the library's
+resources.
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION Stability_Level ##### -->
+
+
+<!-- ##### FUNCTION xfconf_init ##### -->
+<para>
+
+</para>
+
+@error: 
+@Returns: 
+
+
+<!-- ##### FUNCTION xfconf_shutdown ##### -->
+<para>
+
+</para>
+
+
+
diff --git a/docs/reference/version.xml.in b/docs/reference/version.xml.in
new file mode 100644
index 0000000..d78bda9
--- /dev/null
+++ b/docs/reference/version.xml.in
@@ -0,0 +1 @@
+@VERSION@
diff --git a/docs/reference/xfconf-docs.sgml b/docs/reference/xfconf-docs.sgml
new file mode 100644
index 0000000..aaea0cc
--- /dev/null
+++ b/docs/reference/xfconf-docs.sgml
@@ -0,0 +1,19 @@
+<?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>Xfconf Reference Manual</title>
+  </bookinfo>
+
+  <chapter>
+    <title>Xfconf Daemon</title>
+    <xi:include href="xml/xfconf-backend.xml"/>
+  </chapter>
+  
+  <chapter>
+    <title>Xfconf Client Library</title>
+    <xi:include href="xml/xfconf.xml"/>
+    <xi:include href="xml/xfconf-channel.xml"/>
+  </chapter>
+</book>
diff --git a/docs/reference/xfconf-overrides.txt b/docs/reference/xfconf-overrides.txt
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/docs/reference/xfconf-overrides.txt
diff --git a/docs/reference/xfconf-sections.txt b/docs/reference/xfconf-sections.txt
new file mode 100644
index 0000000..cfa06fb
--- /dev/null
+++ b/docs/reference/xfconf-sections.txt
@@ -0,0 +1,53 @@
+<SECTION>
+<FILE>xfconf-channel</FILE>
+XfconfChannel
+xfconf_channel_new
+xfconf_channel_has_property
+xfconf_channel_remove_property
+xfconf_channel_get_all
+xfconf_channel_get_string
+xfconf_channel_get_string_list
+xfconf_channel_get_int
+xfconf_channel_get_int64
+xfconf_channel_get_double
+xfconf_channel_get_bool
+xfconf_channel_set_string
+xfconf_channel_set_string_list
+xfconf_channel_set_int
+xfconf_channel_set_int64
+xfconf_channel_set_double
+xfconf_channel_set_bool
+<SUBSECTION Standard>
+XFCONF_CHANNEL
+XFCONF_IS_CHANNEL
+XFCONF_TYPE_CHANNEL
+xfconf_channel_get_type
+XFCONF_CHANNEL_CLASS
+XFCONF_IS_CHANNEL_CLASS
+XFCONF_CHANNEL_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>xfconf-backend</FILE>
+XFCONF_BACKEND_ERROR
+XfconfBackendInterface
+xfconf_backend_initialize
+xfconf_backend_set
+xfconf_backend_get
+xfconf_backend_get_all
+xfconf_backend_exists
+xfconf_backend_remove
+xfconf_backend_flush
+<SUBSECTION Standard>
+XFCONF_BACKEND
+XFCONF_IS_BACKEND
+XFCONF_TYPE_BACKEND
+xfconf_backend_get_type
+</SECTION>
+
+<SECTION>
+<FILE>xfconf</FILE>
+xfconf_init
+xfconf_shutdown
+</SECTION>
+
diff --git a/docs/reference/xfconf.types b/docs/reference/xfconf.types
new file mode 100644
index 0000000..2ebb559
--- /dev/null
+++ b/docs/reference/xfconf.types
@@ -0,0 +1,5 @@
+#include <xfconf/xfconf.h>
+#include <xfconfd/xfconf-backend.h>
+
+xfconf_channel_get_type
+xfconf_backend_get_type