Generate docs for D-Bus interface

3 files changed, 154 insertions, 0 deletions

diff --git a/docs/Makefile.am b/docs/Makefile.am
new file mode 100644
index 0000000..f1c666c
--- /dev/null
+++ b/docs/Makefile.am
@@ -0,0 +1,70 @@
+NULL =
+
+AUTOMAKE_OPTIONS = 1.7
+
+# The name of the module.
+DOC_MODULE=geoclue
+
+# The top-level SGML file.
+DOC_MAIN_SGML_FILE=geoclue-docs.xml
+
+# Extra options to supply to gtkdoc-scan
+SCAN_OPTIONS=--ignore-headers=config.h
+
+# The directory containing the source code. Relative to $(srcdir)
+#DOC_SOURCE_DIR=../src
+
+# Used for dependencies
+HFILE_GLOB=
+#$(top_srcdir)/policy/*.h
+CFILE_GLOB=
+#$(top_srcdir)/policy/*.c
+
+# Headers to ignore
+IGNORE_HFILES= \
+	$(NULL)
+
+# Extra options to supply to gtkdoc-mkdb
+MKDB_OPTIONS=--sgml-mode --output-format=xml
+
+# Extra options to supply to gtkdoc-mktmpl
+MKTMPL_OPTIONS=
+
+docs-org.freedesktop.GeoClue2.Manager.xml:
+	cp $(top_srcdir)/src/docs-org.freedesktop.GeoClue2.Manager.xml .
+docs-org.freedesktop.GeoClue2.Client.xml:
+	cp $(top_srcdir)/src/docs-org.freedesktop.GeoClue2.Client.xml .
+docs-org.freedesktop.GeoClue2.Location.xml:
+	cp $(top_srcdir)/src/docs-org.freedesktop.GeoClue2.Location.xml .
+
+# Non-autogenerated SGML files to be included in $(DOC_MAIN_SGML_FILE)
+content_files =  			    		\
+	version.xml			    		\
+	docs-org.freedesktop.GeoClue2.Manager.xml	\
+	docs-org.freedesktop.GeoClue2.Client.xml	\
+	docs-org.freedesktop.GeoClue2.Location.xml	\
+	$(NULL)
+
+MAINTAINERCLEANFILES =		\
+	*~			\
+	Makefile.in		\
+	geoclue.types		\
+	geoclue-*.txt		\
+	$(NULL)
+
+if ENABLE_GTK_DOC
+include $(top_srcdir)/gtk-doc.make
+else
+CLEANFILES = $(NULL)
+EXTRA_DIST = geoclue-docs.xml
+endif
+
+CLEANFILES +=						\
+	docs-org.freedesktop.GeoClue2.Manager.xml	\
+	docs-org.freedesktop.GeoClue2.Client.xml	\
+	docs-org.freedesktop.GeoClue2.Location.xml	\
+	$(NULL)
+
+# Version information for marking the documentation
+EXTRA_DIST += version.xml.in
+
diff --git a/docs/geoclue-docs.xml b/docs/geoclue-docs.xml
new file mode 100644
index 0000000..731b47c
--- /dev/null
+++ b/docs/geoclue-docs.xml
@@ -0,0 +1,83 @@
+<?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 version SYSTEM "version.xml">
+]>
+<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
+  <bookinfo>
+    <title>Geoclue Reference Manual</title>
+    <releaseinfo>Version &version;</releaseinfo>
+    <authorgroup>
+      <author>
+	<firstname>Zeeshan</firstname>
+	<surname>Ali (Khattak)</surname>
+	<affiliation>
+	  <address>
+	    <email>zeeshanak@gnome.org</email>
+	  </address>
+	</affiliation>
+      </author>
+    </authorgroup>
+
+    <copyright>
+      <year>2013</year>
+      <holder>Red Hat, Inc.</holder>
+    </copyright>
+
+    <legalnotice>
+      <para>
+	Permission is granted to copy, distribute and/or modify this
+	document under the terms of the <citetitle>GNU Free
+	Documentation License</citetitle>, Version 1.1 or any later
+	version published by the Free Software Foundation with no
+	Invariant Sections, no Front-Cover Texts, and no Back-Cover
+	Texts. You may obtain a copy of the <citetitle>GNU Free
+	Documentation License</citetitle> from the Free Software
+	Foundation by visiting <ulink type="http"
+	url="http://www.fsf.org">their Web site</ulink> or by writing
+	to:
+
+	<address>
+	  The Free Software Foundation, Inc.,
+	  <street>59 Temple Place</street> - Suite 330,
+	  <city>Boston</city>, <state>MA</state> <postcode>02111-1307</postcode>,
+	  <country>USA</country>
+	</address>
+      </para>
+
+      <para>
+	Many of the names used by companies to distinguish their
+	products and services are claimed as trademarks. Where those
+	names appear in any GNOME documentation, and those trademarks
+	are made aware to the members of the GNOME Documentation
+	Project, the names have been printed in caps or initial caps.
+      </para>
+    </legalnotice>
+  </bookinfo>
+
+  <reference id="ref-dbus">
+    <title>D-Bus API Reference</title>
+    <partintro>
+      <para>
+	This part documents the D-Bus interface used to access the
+	Geoclue service.
+      </para>
+    </partintro>
+    <xi:include href="docs-org.freedesktop.GeoClue2.Manager.xml"/>
+    <xi:include href="docs-org.freedesktop.GeoClue2.Client.xml"/>
+    <xi:include href="docs-org.freedesktop.GeoClue2.Location.xml"/>
+  </reference>
+
+  <index>
+    <title>Index</title>
+  </index>
+
+  <!-- License -->
+
+  <appendix id="license">
+    <title>License</title>
+    <para>
+<programlisting><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../COPYING" parse="text"><xi:fallback>FIXME: MISSING XINCLUDE CONTENT</xi:fallback></xi:include></programlisting>
+    </para>
+  </appendix>
+</book>
diff --git a/docs/version.xml.in b/docs/version.xml.in
new file mode 100644
index 0000000..d78bda9
--- /dev/null
+++ b/docs/version.xml.in
@@ -0,0 +1 @@
+@VERSION@