Added the public API documentation

diff --git a/Makefile.am b/Makefile.am
index 85b9aba..1b64c58 100644 (file)
--- a/Makefile.am
+++ b/Makefile.am
@@ -4,6 +4,7 @@ ACLOCAL_AMFLAGS = -I m4
 # also --enable-dbus-type=session here
 AM_DISTCHECK_CONFIGURE_FLAGS = \
     --enable-debug \
+    --enable-gtk-doc \
     --enable-distcheck
 
 pkgconfigdir = $(libdir)/pkgconfig
@@ -11,7 +12,7 @@ pkgconfig_DATA = gsignond.pc
 
 dist_sysconf_DATA = gsignond.conf
 
-SUBDIRS = src test
+SUBDIRS = src test docs
 
 EXTRA_DIST = dists tools
 

diff --git a/autogen.sh b/autogen.sh
index 7609c1f..4e2208f 100755 (executable)
--- a/autogen.sh
+++ b/autogen.sh
@@ -3,6 +3,7 @@
 srcdir=`dirname $0`
 test -z "$srcdir" && srcdir=.
 
+gtkdocize || exit 1
 aclocal #-I m4 
 autoheader 
 libtoolize --copy --force 

diff --git a/configure.ac b/configure.ac
index e8aa740..046f90f 100644 (file)
--- a/configure.ac
+++ b/configure.ac
@@ -132,7 +132,7 @@ AC_SUBST(DBUS_SERVICES_DIR)
 AC_SUBST(DBUS_INTERFACES_DIR)
 
 # gtk-doc
-GTK_DOC_CHECK
+GTK_DOC_CHECK([1.18],[--flavour no-tmpl])
 
 # Checks for header files.
 AC_CHECK_HEADERS([string.h])
@@ -150,6 +150,7 @@ AC_OUTPUT([
 Makefile
 ${PACKAGE_NAME}.pc
 ${PACKAGE_NAME}-uninstalled.pc
+docs/Makefile
 src/Makefile
 src/common/Makefile
 src/common/db/Makefile

diff --git a/docs/Makefile.am b/docs/Makefile.am
new file mode 100644 (file)
index 0000000..0567fbc
--- /dev/null
+++ b/docs/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=gsignond
+
+# 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.
+# 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)/include $(top_srcdir)/src/common
+
+# 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=--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=\
+    $(top_builddir)/src/common/libgsignond-common.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

diff --git a/docs/gsignond-docs.sgml b/docs/gsignond-docs.sgml
new file mode 100644 (file)
index 0000000..09c85f2
--- /dev/null
+++ b/docs/gsignond-docs.sgml
@@ -0,0 +1,64 @@
+<?xml version="1.0"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+               "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
+[
+  <!ENTITY % local.common.attrib "xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'">
+]>
+<book id="index">
+  <bookinfo>
+    <title>gsignond Reference Manual</title>
+    <releaseinfo>
+      for gsignond [VERSION].
+      The latest version of this documentation can be found on-line at
+      <ulink role="online-location" url="http://[SERVER]/gsignond/index.html">http://[SERVER]/gsignond/</ulink>.
+    </releaseinfo>
+  </bookinfo>
+
+  <chapter>
+    <title>[Insert title here]</title>
+        <xi:include href="xml/gsignond-access-control-manager.xml"/>
+    <xi:include href="xml/gsignond-config.xml"/>
+    <xi:include href="xml/gsignond-config-db.xml"/>
+    <xi:include href="xml/gsignond-config-dbus.xml"/>
+    <xi:include href="xml/gsignond-config-general.xml"/>
+    <xi:include href="xml/gsignond-credentials.xml"/>
+    <xi:include href="xml/gsignond-db-defines.xml"/>
+    <xi:include href="xml/gsignond-db-error.xml"/>
+    <xi:include href="xml/gsignond-db-secret-database.xml"/>
+    <xi:include href="xml/gsignond-db-sql-database.xml"/>
+    <xi:include href="xml/gsignond-db-sql-database-private.xml"/>
+    <xi:include href="xml/gsignond-dictionary.xml"/>
+    <xi:include href="xml/gsignond-disposable.xml"/>
+    <xi:include href="xml/gsignond-error.xml"/>
+    <xi:include href="xml/gsignond-extension-interface.xml"/>
+    <xi:include href="xml/gsignond-identity-info.xml"/>
+    <xi:include href="xml/gsignond-identity-info-internal.xml"/>
+    <xi:include href="xml/gsignond-log.xml"/>
+    <xi:include href="xml/gsignond-pipe-stream.xml"/>
+    <xi:include href="xml/gsignond-plugin-enum-types.xml"/>
+    <xi:include href="xml/gsignond-plugin-interface.xml"/>
+    <xi:include href="xml/gsignond-plugin-loader.xml"/>
+    <xi:include href="xml/gsignond-secret-storage.xml"/>
+    <xi:include href="xml/gsignond-security-context.xml"/>
+    <xi:include href="xml/gsignond-session-data.xml"/>
+    <xi:include href="xml/gsignond-signonui.xml"/>
+    <xi:include href="xml/gsignond-signonui-data.xml"/>
+    <xi:include href="xml/gsignond-storage-manager.xml"/>
+    <xi:include href="xml/gsignond-utils.xml"/>
+
+  </chapter>
+  <chapter id="object-tree">
+    <title>Object Hierarchy</title>
+     <xi:include href="xml/tree_index.sgml"/>
+  </chapter>
+  <index id="api-index-full">
+    <title>API Index</title>
+    <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
+  </index>
+  <index id="deprecated-api-index" role="deprecated">
+    <title>Index of deprecated API</title>
+    <xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
+  </index>
+
+  <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
+</book>

diff --git a/include/gsignond/gsignond-dictionary.h b/include/gsignond/gsignond-dictionary.h
index 400f970..b0239b5 100644 (file)
--- a/include/gsignond/gsignond-dictionary.h
+++ b/include/gsignond/gsignond-dictionary.h
@@ -41,9 +41,6 @@ G_BEGIN_DECLS
 
 typedef GHashTable GSignondDictionary;
 
-GType
-gsignond_dictionary_get_type (void);
-
 GSignondDictionary *
 gsignond_dictionary_new (void);
 

diff --git a/src/common/gsignond-identity-info.c b/src/common/gsignond-identity-info.c
index d521956..8f3f3d4 100644 (file)
--- a/src/common/gsignond-identity-info.c
+++ b/src/common/gsignond-identity-info.c
@@ -683,7 +683,7 @@ gsignond_identity_info_set_realms (
  * @info: instance of #GSignondIdentityInfo
  *
  * Retrieves the methods from the info whereas #GHashTable consists of
- * <gchar*,GSequence*> and #GSequence is a sequence of gchar *.
+ * (gchar*,GSequence*) and #GSequence is a sequence of gchar *.
  *
  * Returns: (transfer full) the methods if successful, NULL otherwise.
  * when done, methods should be freed using g_hash_table_unref.
@@ -724,7 +724,7 @@ gsignond_identity_info_get_methods (GSignondIdentityInfo *info)
  * @info: instance of #GSignondIdentityInfo
  *
  * @methods: (transfer none) methods to be set whereas #GHashTable consists of
- * <gchar*,#GSequence*> and #GSequence is a sequence of gchar *.
+ * (gchar*,#GSequence*) and #GSequence is a sequence of gchar *.
  *
  * Sets the methods of the info.
  *