[tracker] libtracker-client: Added reference pages

[Martyn James Russell <mr src gnome org>]

commit ec7cf39fbc4e475c3a9df2e2919f2b6e9b000bc4
Author: Martyn Russell <martyn lanedo com>
Date:   Tue Dec 1 16:02:57 2009 +0200

    libtracker-client: Added reference pages

 configure.ac                                       |    2 +
 docs/reference/Makefile.am                         |    1 +
 docs/reference/libtracker-client/Makefile.am       |   70 +++++++++++++++
 .../libtracker-client/libtracker-client-docs.sgml  |   42 +++++++++
 .../libtracker-client-sections.txt                 |   91 ++++++++++++++++++++
 docs/reference/libtracker-client/version.xml.in    |    1 +
 6 files changed, 207 insertions(+), 0 deletions(-)
---
diff --git a/configure.ac b/configure.ac
index 8773a8d..5319909 100644
--- a/configure.ac
+++ b/configure.ac
@@ -1491,6 +1491,8 @@ AC_CONFIG_FILES([
 	docs/design/Makefile
 	docs/manpages/Makefile
 	docs/reference/Makefile
+	docs/reference/libtracker-client/Makefile
+	docs/reference/libtracker-client/version.xml
 	docs/reference/libtracker-common/Makefile
 	docs/reference/libtracker-common/version.xml
 	docs/reference/libtracker-miner/Makefile
diff --git a/docs/reference/Makefile.am b/docs/reference/Makefile.am
index d57c1dc..48b3c9a 100644
--- a/docs/reference/Makefile.am
+++ b/docs/reference/Makefile.am
@@ -1,6 +1,7 @@
 include $(top_srcdir)/Makefile.decl
 
 SUBDIRS = 			\
+	libtracker-client	\
 	libtracker-common	\
 	libtracker-miner
 
diff --git a/docs/reference/libtracker-client/Makefile.am b/docs/reference/libtracker-client/Makefile.am
new file mode 100644
index 0000000..984b077
--- /dev/null
+++ b/docs/reference/libtracker-client/Makefile.am
@@ -0,0 +1,70 @@
+include $(top_srcdir)/Makefile.decl
+
+AUTOMAKE_OPTIONS = 1.6
+
+# The name of the module.
+DOC_MODULE = libtracker-client
+
+# The top-level SGML file.
+DOC_MAIN_SGML_FILE = libtracker-client-docs.sgml
+
+# Extra options to supply to gtkdoc-scan
+# SCAN_OPTIONS=--deprecated-guards="G_GNUC_DEPRECATED"
+
+# Extra options to pass to gtkdoc-scangobj
+# SCANGOBJ_OPTIONS=--type-init-func="gtk_type_init(0)" 
+
+# The directory containing the source code. Relative to $(srcdir)
+DOC_SOURCE_DIR = ../../../src/libtracker-client
+
+# Used for dependencies
+HFILE_GLOB = $(top_srcdir)/src/libtracker-client/*.h
+CFILE_GLOB = $(top_srcdir)/src/libtracker-client/*.c
+
+# Header files to ignore when scanning
+IGNORE_HFILES = 			\
+	tracker-resources-glue.h	\
+	tracker-statistics-glue.h
+
+# CFLAGS and LDFLAGS for compiling scan program. Only needed
+# if $(DOC_MODULE).types is non-empty.
+INCLUDES = 								\
+	-DTRACKER_COMPILATION						\
+	-I$(top_srcdir)/src						\
+	$(GLIB2_CFLAGS)							\
+	$(GIO_CFLAGS)							\
+	$(PANGO_CFLAGS)							\
+	$(HAL_CFLAGS)							\
+	$(DBUS_CFLAGS)							\
+	$(UNAC_CFLAGS)
+
+GTKDOC_LIBS =								\
+	$(top_builddir)/src/libtracker-client/libtracker-client- TRACKER_API_VERSION@.la \
+	$(top_builddir)/src/libtracker-common/libtracker-common.la	\
+	$(HAL_LIBS)							\
+	$(DBUS_LIBS)							\
+	$(UNAC_LIBS)							\
+	$(PANGO_LIBS)							\
+	$(GIO_LIBS)							\
+	$(GLIB2_LIBS)
+
+
+# Extra options to supply to gtkdoc-mkdb
+MKDB_OPTIONS = --sgml-mode --output-format=xml
+
+# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE)
+content_files =						\
+	version.xml
+
+expand_content_files =
+
+# Images to copy into HTML directory
+HTML_IMAGES =
+
+# Extra options to supply to gtkdoc-fixref
+FIXXREF_OPTIONS =
+
+include $(top_srcdir)/gtk-doc.make
+
+# Other files to distribute
+EXTRA_DIST += version.xml.in
diff --git a/docs/reference/libtracker-client/libtracker-client-docs.sgml b/docs/reference/libtracker-client/libtracker-client-docs.sgml
new file mode 100644
index 0000000..db0edc7
--- /dev/null
+++ b/docs/reference/libtracker-client/libtracker-client-docs.sgml
@@ -0,0 +1,42 @@
+<?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"; [
+<!ENTITY tracker SYSTEM "xml/tracker.xml">
+<!ENTITY tracker-cancel SYSTEM "xml/tracker_cancel.xml">
+<!ENTITY tracker-sparql SYSTEM "xml/tracker_sparql.xml">
+<!ENTITY tracker-statistics SYSTEM "xml/tracker_statistics.xml">
+<!ENTITY tracker-resources SYSTEM "xml/tracker_resources.xml">
+<!ENTITY version SYSTEM "version.xml">
+]>
+<book id="index">
+  <bookinfo>
+    <title>Tracker Client Library Reference Manual</title>
+    <releaseinfo>for libtracker-client &version;</releaseinfo>
+  </bookinfo>
+
+  <part id="libtracker-client">
+    <title>Overview</title>
+    <partintro>
+      <para>
+        The libtracker-client library is the foundation for Tracker
+        querying and inserting into the data store. The data store
+        allows both querying and inserting using SPARQL based on the
+        Nepomuk ontology.
+      </para>
+      <para>
+      </para>
+    </partintro>
+  </part>
+
+    <chapter>
+      <title>General</title>
+      &tracker;
+      &tracker-cancel;
+      &tracker-sparql;
+    </chapter>
+    <chapter>
+      <title>Querying</title>
+      &tracker-statistics;
+      &tracker-resources;
+    </chapter>
+</book>
diff --git a/docs/reference/libtracker-client/libtracker-client-sections.txt b/docs/reference/libtracker-client/libtracker-client-sections.txt
new file mode 100644
index 0000000..f0d4697
--- /dev/null
+++ b/docs/reference/libtracker-client/libtracker-client-sections.txt
@@ -0,0 +1,91 @@
+<SECTION>
+<FILE>tracker</FILE>
+<TITLE>Connecting</TITLE>
+TrackerClient
+tracker_connect
+tracker_disconnect
+</SECTION>
+
+<SECTION>
+<FILE>tracker_cancel</FILE>
+<TITLE>Cancellations</TITLE>
+tracker_cancel_call
+tracker_cancel_last_call
+</SECTION>
+
+<SECTION>
+<FILE>tracker_sparql</FILE>
+<TITLE>Utilities</TITLE>
+tracker_sparql_escape
+</SECTION>
+
+<SECTION>
+<FILE>tracker_statistics</FILE>
+<TITLE>Statistics</TITLE>
+tracker_statistics_get
+tracker_statistics_get_async
+</SECTION>
+
+<SECTION>
+<FILE>tracker_resources</FILE>
+<TITLE>Resources</TITLE>
+TrackerReplyArray
+TrackerReplyGPtrArray
+TrackerReplyVoid
+tracker_resources_load
+tracker_resources_sparql_query
+tracker_resources_sparql_update
+tracker_resources_sparql_update_blank
+tracker_resources_batch_sparql_update
+tracker_resources_batch_commit
+tracker_resources_load_async
+tracker_resources_sparql_query_async
+tracker_resources_sparql_update_async
+tracker_resources_sparql_update_blank_async
+tracker_resources_batch_sparql_update_async
+tracker_resources_batch_commit_async
+</SECTION>
+
+<SECTION>
+<FILE>tracker_search</FILE>
+<TITLE>Search (Deprecated)</TITLE>
+TrackerReplyGPtrArray
+tracker_search_metadata_by_text_async
+tracker_search_metadata_by_text_and_location_async
+tracker_search_metadata_by_text_and_mime_async
+tracker_search_metadata_by_text_and_mime_and_location_async
+</SECTION>
+
+<SECTION>
+<FILE>tracker-resources-glue</FILE>
+DBUS_GLIB_CLIENT_WRAPPERS_org_freedesktop_Tracker1_Resources
+org_freedesktop_Tracker1_Resources_load
+org_freedesktop_Tracker1_Resources_load_reply
+org_freedesktop_Tracker1_Resources_load_async
+dbus_g_proxy_begin_call
+org_freedesktop_Tracker1_Resources_sparql_query
+org_freedesktop_Tracker1_Resources_sparql_query_reply
+org_freedesktop_Tracker1_Resources_sparql_query_async
+org_freedesktop_Tracker1_Resources_sparql_update
+org_freedesktop_Tracker1_Resources_sparql_update_reply
+org_freedesktop_Tracker1_Resources_sparql_update_async
+org_freedesktop_Tracker1_Resources_sparql_update_blank
+org_freedesktop_Tracker1_Resources_sparql_update_blank_reply
+org_freedesktop_Tracker1_Resources_sparql_update_blank_async
+org_freedesktop_Tracker1_Resources_batch_sparql_update
+org_freedesktop_Tracker1_Resources_batch_sparql_update_reply
+org_freedesktop_Tracker1_Resources_batch_sparql_update_async
+org_freedesktop_Tracker1_Resources_batch_commit
+org_freedesktop_Tracker1_Resources_batch_commit_reply
+org_freedesktop_Tracker1_Resources_batch_commit_async
+</SECTION>
+
+<SECTION>
+<FILE>tracker-statistics-glue</FILE>
+DBUS_GLIB_CLIENT_WRAPPERS_org_freedesktop_Tracker1_Statistics
+org_freedesktop_Tracker1_Statistics_get
+org_freedesktop_Tracker1_Statistics_get_reply
+org_freedesktop_Tracker1_Statistics_get_async
+dbus_g_proxy_begin_call
+</SECTION>
+
diff --git a/docs/reference/libtracker-client/libtracker-client.types b/docs/reference/libtracker-client/libtracker-client.types
new file mode 100644
index 0000000..e69de29
diff --git a/docs/reference/libtracker-client/version.xml.in b/docs/reference/libtracker-client/version.xml.in
new file mode 100644
index 0000000..c7e1225
--- /dev/null
+++ b/docs/reference/libtracker-client/version.xml.in
@@ -0,0 +1 @@
+ TRACKER_VERSION@