[libcloudproviders: 2/8] Add basic documentation building

[Gitlab System User <gitlab src gnome org>]

commit d4e2e91a2bd2b8745ed401ba96a872250a109e21
Author: Julius Härtl <jus bitgrid net>
Date:   Mon Jul 17 12:51:37 2017 +0200

    Add basic documentation building

 doc/cloudproviderd.xml          | 68 +++++++++++++++++++++++++++++++++++++++++
 doc/libcloudproviders-docs.sgml | 61 ++++++++++++++++++++++++++++++++++++
 doc/meson.build                 | 12 ++++++++
 doc/version.xml.in              |  1 +
 meson.build                     |  1 +
 src/cloudproviders.c            |  4 +--
 6 files changed, 145 insertions(+), 2 deletions(-)
---
diff --git a/doc/cloudproviderd.xml b/doc/cloudproviderd.xml
new file mode 100644
index 0000000..44c3bde
--- /dev/null
+++ b/doc/cloudproviderd.xml
@@ -0,0 +1,68 @@
+<refentry id="gdbus-codegen" lang="en">
+
+<refentryinfo>
+  <title>gdbus</title>
+  <productname>cloudproviders</productname>
+  <authorgroup>
+    <author>
+      <contrib>Developer</contrib>
+      <firstname>David</firstname>
+      <surname>Zeuthen</surname>
+      <email>zeuthen gmail com</email>
+    </author>
+  </authorgroup>
+</refentryinfo>
+
+<refmeta>
+  <refentrytitle>cloudproviderd</refentrytitle>
+  <manvolnum>1</manvolnum>
+  <refmiscinfo class="manual">User Commands</refmiscinfo>
+</refmeta>
+
+<refnamediv>
+  <refname>gdbus-codegen</refname>
+  <refpurpose>D-Bus code and documentation generator</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+  <cmdsynopsis>
+    <command>gdbus-codegen</command>
+    <arg><option>-h</option>, <option>--help</option></arg>
+    <arg><option>--interface-prefix</option> <replaceable>org.project.Prefix</replaceable></arg>
+    <arg><option>--generate-c-code</option> <replaceable>OUTFILES</replaceable></arg>
+    <arg><option>--c-namespace</option> <replaceable>YourProject</replaceable></arg>
+    <arg><option>--c-generate-object-manager</option></arg>
+    <arg><option>--c-generate-autocleanup</option> none|objects|all</arg>
+    <arg><option>--output-directory</option> <replaceable>OUTDIR</replaceable></arg>
+    <arg><option>--generate-docbook</option> <replaceable>OUTFILES</replaceable></arg>
+    <arg><option>--xml-files</option> <replaceable>FILE</replaceable></arg>
+    <group choice="plain" rep="repeat">
+      <arg>
+        <option>--annotate</option>
+        <replaceable>ELEMENT</replaceable>
+        <replaceable>KEY</replaceable>
+        <replaceable>VALUE</replaceable>
+      </arg>
+    </group>
+    <arg choice="plain">FILE</arg>
+    <arg>
+      <arg choice="plain" rep="repeat">FILE</arg>
+    </arg>
+  </cmdsynopsis>
+</refsynopsisdiv>
+
+<refsect1>
+  <title>Description</title>
+  <para>
+    <command>gdbus-codegen</command> is used to generate code and/or
+    documentation for one or more D-Bus interfaces. The tool reads
+    <ulink
+    url="http://dbus.freedesktop.org/doc/dbus-specification.html#introspection-format";>D-Bus
+    Introspection XML</ulink> files and generates output files. The
+    tool currently supports generating C code (via
+    <option>--generate-c-code</option>) and Docbook XML (via
+    <option>--generate-docbook</option>).
+  </para>
+</refsect1>
+
+</refentry>
diff --git a/doc/libcloudproviders-docs.sgml b/doc/libcloudproviders-docs.sgml
new file mode 100644
index 0000000..e252ecc
--- /dev/null
+++ b/doc/libcloudproviders-docs.sgml
@@ -0,0 +1,61 @@
+<?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>CloudProviders Reference Manual</title>
+    <releaseinfo>
+      for cloudproviders &version;
+    </releaseinfo>
+    <authorgroup>
+      <author>
+        <firstname>Julius</firstname>
+        <surname>Härtl</surname>
+        <affiliation>
+          <address>
+            <email>jus bitgrid net</email>
+          </address>
+        </affiliation>
+      </author>
+    </authorgroup>
+    <copyright>
+      <year>2017</year>
+      <holder>Julius Härtl</holder>
+    </copyright>
+  </bookinfo>
+
+  <reference id="libcloudproviders">
+    <title>libcloudproviders library</title>
+    <partintro>
+      <para>
+        This part documents libcloudproviders libs.
+      </para>
+    </partintro>
+    <xi:include href="xml/cloudprovider.xml"/>
+    <xi:include href="xml/cloudprovider-generated.xml"/>
+    <xi:include href="xml/cloudproviders.xml"/>
+    <xi:include href="xml/cloudprovidermanager.xml"/>
+    <xi:include href="xml/cloudproviderproxy.xml"/>
+  </reference>
+
+  <reference id="cloudproviderd">
+    <title>cloudproviderd daemon</title>
+    <partintro>
+      <para>
+        This part documents libcloudproviders libs.
+      </para>
+    </partintro>
+    <xi:include href="xml/cloudproviderd.xml" />
+  </reference>
+
+  <reference id="cloudproviders-dbus">
+    <title>DBus Interfaces</title>
+    <partintro>
+      <para>
+      </para>
+    </partintro>
+  </reference>
+
+</book>
diff --git a/doc/meson.build b/doc/meson.build
new file mode 100644
index 0000000..7401c94
--- /dev/null
+++ b/doc/meson.build
@@ -0,0 +1,12 @@
+cdata = configuration_data()
+cdata.set('VERSION', '1.0')
+configure_file(input : 'version.xml.in',
+  output : 'version.xml',
+  configuration : cdata)
+
+inc = include_directories('../src')
+
+gnome.gtkdoc('libcloudproviders', src_dir : inc,
+main_sgml : 'libcloudproviders-docs.sgml',
+content_files: ['../data/cloudprovidermanager-dbus.xml'],
+install : true)
diff --git a/doc/version.xml.in b/doc/version.xml.in
new file mode 100644
index 0000000..d78bda9
--- /dev/null
+++ b/doc/version.xml.in
@@ -0,0 +1 @@
+@VERSION@
diff --git a/meson.build b/meson.build
index 90484a6..7f0ca79 100644
--- a/meson.build
+++ b/meson.build
@@ -25,3 +25,4 @@ conf.set_quoted ('GETTEXT_PACKAGE', 'cloudproviders')
 
 subdir ( 'src' )
 subdir ( 'test' )
+subdir ( 'doc' )
diff --git a/src/cloudproviders.c b/src/cloudproviders.c
index 2cfc5e2..36e0995 100644
--- a/src/cloudproviders.c
+++ b/src/cloudproviders.c
@@ -211,8 +211,8 @@ cloud_providers_init (CloudProviders *self)
 
 /**
  * cloud_providers_get_providers
- * @manager: A CloudProviders
- * Returns: (transfer none): The list of providers.
+ * @self: A CloudProviders
+ * Returns: (transfer none): A GList* of #CloudProviderProxy objects.
  */
 GList*
 cloud_providers_get_providers (CloudProviders *self)