lib: Generate docs

https://bugs.freedesktop.org/show_bug.cgi?id=68658

5 files changed, 398 insertions, 0 deletions

diff --git a/docs/Makefile.am b/docs/Makefile.am
index 2b7781f..7494fc7 100644
--- a/docs/Makefile.am
+++ b/docs/Makefile.am
@@ -2,6 +2,8 @@ NULL =
 
 AUTOMAKE_OPTIONS = 1.7
 
+SUBDIRS = lib
+
 # The name of the module.
 DOC_MODULE=geoclue
 
diff --git a/docs/lib/Makefile.am b/docs/lib/Makefile.am
new file mode 100644
index 0000000..bf17180
--- /dev/null
+++ b/docs/lib/Makefile.am
@@ -0,0 +1,66 @@
+NULL =
+
+AUTOMAKE_OPTIONS = 1.7
+
+# The name of the module.
+DOC_MODULE=libgeoclue
+
+# The top-level SGML file.
+DOC_MAIN_SGML_FILE=libgeoclue-docs.xml
+
+# Extra options to supply to gtkdoc-scan
+SCAN_OPTIONS=--ignore-headers=config.h --rebuild-types
+
+# The directory containing the source code. Relative to $(srcdir)
+DOC_SOURCE_DIR=../../libgeoclue
+
+# Used for dependencies
+HFILE_GLOB=
+CFILE_GLOB=
+
+# Headers to ignore
+IGNORE_HFILES= \
+	$(NULL)
+
+GTKDOC_LIBS = $(top_srcdir)/libgeoclue/libgeoclue-2.la
+
+# Extra options to supply to gtkdoc-mkdb
+MKDB_OPTIONS=--sgml-mode --output-format=xml
+
+# Extra options to supply to gtkdoc-mktmpl
+MKTMPL_OPTIONS=
+
+# Non-autogenerated SGML files to be included in $(DOC_MAIN_SGML_FILE)
+content_files =  			    		\
+	version.xml			    		\
+	$(NULL)
+
+MAINTAINERCLEANFILES =		\
+	*~			\
+	Makefile.in		\
+	libgeoclue.types	\
+        libgeoclue-decl-list.txt \
+        libgeoclue-decl.txt \
+        libgeoclue-overrides.txt \
+        libgeoclue-undeclared.txt \
+        libgeoclue-undocumented.txt \
+        libgeoclue-overrides.txt \
+        libgeoclue-unused.txt \
+        libgeoclue.args \
+        libgeoclue.hierarchy \
+        libgeoclue.interfaces \
+        libgeoclue.prerequisites \
+        libgeoclue.signals \
+	$(NULL)
+
+if ENABLE_GTK_DOC
+include $(top_srcdir)/gtk-doc.make
+else
+CLEANFILES = $(NULL)
+EXTRA_DIST = libgeoclue-docs.xml
+endif
+
+# Version information for marking the documentation
+EXTRA_DIST += version.xml.in
+
+-include $(top_srcdir)/git.mk
diff --git a/docs/lib/libgeoclue-docs.xml b/docs/lib/libgeoclue-docs.xml
new file mode 100644
index 0000000..145dd31
--- /dev/null
+++ b/docs/lib/libgeoclue-docs.xml
@@ -0,0 +1,98 @@
+<?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>Libgeoclue 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>2015</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>
+
+  <chapter>
+    <title>Common enums and flags helpers</title>
+    <xi:include href="xml/gclue-enums.xml"/>
+  </chapter>
+
+  <chapter>
+    <title>Convenient helpers</title>
+    <xi:include href="xml/gclue-helpers.xml"/>
+  </chapter>
+
+  <chapter>
+    <title>The Manager object</title>
+    <xi:include href="xml/gclue-manager.xml"/>
+    <xi:include href="xml/gclue-manager-proxy.xml"/>
+  </chapter>
+
+  <chapter>
+    <title>The Client object</title>
+    <xi:include href="xml/gclue-client.xml"/>
+    <xi:include href="xml/gclue-client-proxy.xml"/>
+  </chapter>
+
+  <chapter>
+    <title>The Location object</title>
+    <xi:include href="xml/gclue-location.xml"/>
+    <xi:include href="xml/gclue-location-proxy.xml"/>
+  </chapter>
+
+  <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.LIB" parse="text"><xi:fallback>FIXME: MISSING XINCLUDE CONTENT</xi:fallback></xi:include></programlisting>
+    </para>
+  </appendix>
+</book>
diff --git a/docs/lib/libgeoclue-sections.txt b/docs/lib/libgeoclue-sections.txt
new file mode 100644
index 0000000..9a9ee9c
--- /dev/null
+++ b/docs/lib/libgeoclue-sections.txt
@@ -0,0 +1,231 @@
+<SECTION>
+<FILE>GClueClient</FILE>
+<TITLE>GClueClient</TITLE>
+<SUBSECTION Private>
+GCLUE_CLIENT_SKELETON
+GCLUE_CLIENT_SKELETON_CLASS
+GCLUE_CLIENT_SKELETON_GET_CLASS
+GCLUE_IS_CLIENT_SKELETON
+GCLUE_IS_CLIENT_SKELETON_CLASS
+GCLUE_TYPE_CLIENT_SKELETON
+GClueClientSkeleton
+GClueClientSkeletonClass
+GClueClientSkeletonPrivate
+gclue_client_skeleton_get_type
+gclue_client_skeleton_new
+</SECTION>
+
+<SECTION>
+<FILE>gclue-client</FILE>
+<TITLE>GClueClient</TITLE>
+gclue_client_interface_info
+gclue_client_override_properties
+gclue_client_complete_start
+gclue_client_complete_stop
+gclue_client_emit_location_updated
+gclue_client_call_start
+gclue_client_call_start_finish
+gclue_client_call_start_sync
+gclue_client_call_stop
+gclue_client_call_stop_finish
+gclue_client_call_stop_sync
+gclue_client_get_location
+gclue_client_dup_location
+gclue_client_set_location
+gclue_client_get_distance_threshold
+gclue_client_set_distance_threshold
+gclue_client_get_desktop_id
+gclue_client_dup_desktop_id
+gclue_client_set_desktop_id
+gclue_client_get_requested_accuracy_level
+gclue_client_set_requested_accuracy_level
+gclue_client_get_active
+gclue_client_set_active
+<SUBSECTION Standard>
+GCLUE_CLIENT
+GCLUE_CLIENT_GET_IFACE
+GCLUE_IS_CLIENT
+GCLUE_TYPE_CLIENT
+GClueClient
+GClueClientIface
+gclue_client_get_type
+</SECTION>
+
+<SECTION>
+<FILE>gclue-client-proxy</FILE>
+<TITLE>GClueClientProxy</TITLE>
+gclue_client_proxy_new
+gclue_client_proxy_new_finish
+gclue_client_proxy_new_sync
+gclue_client_proxy_new_for_bus
+gclue_client_proxy_new_for_bus_finish
+gclue_client_proxy_new_for_bus_sync
+<SUBSECTION Standard>
+GCLUE_CLIENT_PROXY
+GCLUE_CLIENT_PROXY_CLASS
+GCLUE_CLIENT_PROXY_GET_CLASS
+GCLUE_IS_CLIENT_PROXY
+GCLUE_IS_CLIENT_PROXY_CLASS
+GCLUE_TYPE_CLIENT_PROXY
+GClueClientProxy
+GClueClientProxyClass
+gclue_client_proxy_get_type
+<SUBSECTION Private>
+GClueClientProxyPrivate
+</SECTION>
+
+<SECTION>
+<FILE>gclue-enums</FILE>
+GClueAccuracyLevel
+GCLUE_TYPE_ACCURACY_LEVEL
+gclue_accuracy_level_get_type
+<SUBSECTION Private>
+gclue_accuracy_level_build_string_from_mask
+gclue_accuracy_level_get_string
+</SECTION>
+
+<SECTION>
+<FILE>gclue-helpers</FILE>
+gclue_client_proxy_create
+gclue_client_proxy_create_finish
+gclue_client_proxy_create_sync
+gclue_fetch_location
+gclue_fetch_location_finish
+gclue_fetch_location_sync
+</SECTION>
+
+<SECTION>
+<FILE>GClueLocation</FILE>
+<TITLE>GClueLocation</TITLE>
+<SUBSECTION Private>
+GCLUE_IS_LOCATION_SKELETON
+GCLUE_IS_LOCATION_SKELETON_CLASS
+GCLUE_LOCATION_SKELETON
+GCLUE_LOCATION_SKELETON_CLASS
+GCLUE_LOCATION_SKELETON_GET_CLASS
+GCLUE_TYPE_LOCATION_SKELETON
+GClueLocationSkeleton
+GClueLocationSkeletonClass
+GClueLocationSkeletonPrivate
+gclue_location_skeleton_get_type
+gclue_location_skeleton_new
+</SECTION>
+
+<SECTION>
+<FILE>gclue-location</FILE>
+<TITLE>GClueLocation</TITLE>
+gclue_location_interface_info
+gclue_location_override_properties
+gclue_location_get_latitude
+gclue_location_set_latitude
+gclue_location_get_longitude
+gclue_location_set_longitude
+gclue_location_get_accuracy
+gclue_location_set_accuracy
+gclue_location_get_altitude
+gclue_location_set_altitude
+gclue_location_get_speed
+gclue_location_set_speed
+gclue_location_get_heading
+gclue_location_set_heading
+gclue_location_get_description
+gclue_location_dup_description
+gclue_location_set_description
+<SUBSECTION Standard>
+GCLUE_IS_LOCATION
+GCLUE_LOCATION
+GCLUE_LOCATION_GET_IFACE
+GCLUE_TYPE_LOCATION
+GClueLocation
+GClueLocationIface
+gclue_location_get_type
+</SECTION>
+
+<SECTION>
+<FILE>gclue-location-proxy</FILE>
+<TITLE>GClueLocationProxy</TITLE>
+gclue_location_proxy_new
+gclue_location_proxy_new_finish
+gclue_location_proxy_new_sync
+gclue_location_proxy_new_for_bus
+gclue_location_proxy_new_for_bus_finish
+gclue_location_proxy_new_for_bus_sync
+<SUBSECTION Standard>
+GCLUE_IS_LOCATION_PROXY
+GCLUE_IS_LOCATION_PROXY_CLASS
+GCLUE_LOCATION_PROXY
+GCLUE_LOCATION_PROXY_CLASS
+GCLUE_LOCATION_PROXY_GET_CLASS
+GCLUE_TYPE_LOCATION_PROXY
+GClueLocationProxy
+GClueLocationProxyClass
+GClueLocationProxyPrivate
+gclue_location_proxy_get_type
+</SECTION>
+
+<SECTION>
+<FILE>GClueManager</FILE>
+<TITLE>GClueManager</TITLE>
+</SECTION>
+
+<SECTION>
+<FILE>gclue-manager</FILE>
+<TITLE>GClueManager</TITLE>
+gclue_manager_interface_info
+gclue_manager_override_properties
+gclue_manager_complete_get_client
+gclue_manager_complete_add_agent
+gclue_manager_call_get_client
+gclue_manager_call_get_client_finish
+gclue_manager_call_get_client_sync
+gclue_manager_call_add_agent
+gclue_manager_call_add_agent_finish
+gclue_manager_call_add_agent_sync
+gclue_manager_get_in_use
+gclue_manager_set_in_use
+gclue_manager_get_available_accuracy_level
+gclue_manager_set_available_accuracy_level
+<SUBSECTION Standard>
+GCLUE_IS_MANAGER
+GCLUE_MANAGER
+GCLUE_MANAGER_GET_IFACE
+GCLUE_TYPE_MANAGER
+GClueManager
+GClueManagerIface
+gclue_manager_get_type
+<SUBSECTION Private>
+GCLUE_IS_MANAGER_SKELETON
+GCLUE_IS_MANAGER_SKELETON_CLASS
+GCLUE_MANAGER_SKELETON
+GCLUE_MANAGER_SKELETON_CLASS
+GCLUE_MANAGER_SKELETON_GET_CLASS
+GCLUE_TYPE_MANAGER_SKELETON
+GClueManagerSkeleton
+GClueManagerSkeletonClass
+GClueManagerSkeletonPrivate
+gclue_manager_skeleton_get_type
+gclue_manager_skeleton_new
+</SECTION>
+
+<SECTION>
+<FILE>gclue-manager-proxy</FILE>
+<TITLE>GClueManagerProxy</TITLE>
+gclue_manager_proxy_new
+gclue_manager_proxy_new_finish
+gclue_manager_proxy_new_sync
+gclue_manager_proxy_new_for_bus
+gclue_manager_proxy_new_for_bus_finish
+gclue_manager_proxy_new_for_bus_sync
+<SUBSECTION Standard>
+GCLUE_IS_MANAGER_PROXY
+GCLUE_IS_MANAGER_PROXY_CLASS
+GCLUE_MANAGER_PROXY
+GCLUE_MANAGER_PROXY_CLASS
+GCLUE_MANAGER_PROXY_GET_CLASS
+GCLUE_TYPE_MANAGER_PROXY
+GClueManagerProxy
+GClueManagerProxyClass
+gclue_manager_proxy_get_type
+<SUBSECTION Private>
+GClueManagerProxyPrivate
+</SECTION>
diff --git a/docs/lib/version.xml.in b/docs/lib/version.xml.in
new file mode 100644
index 0000000..d78bda9
--- /dev/null
+++ b/docs/lib/version.xml.in
@@ -0,0 +1 @@
+@VERSION@