[devhelp] SettingsBuilder: write documentation

[Sébastien Wilmet <swilmet src gnome org>]

commit 4b2843c296a92a27592790e5a0e362800042507b
Author: Sébastien Wilmet <swilmet gnome org>
Date:   Mon Apr 2 12:59:20 2018 +0200

    SettingsBuilder: write documentation
    
    Anyway needed for the GI annotations.

 devhelp/dh-settings-builder.c       |   32 ++++++++++++++++++++++++++++++++
 docs/reference/devhelp-docs.xml     |    1 +
 docs/reference/devhelp-sections.txt |   18 ++++++++++++++++++
 docs/reference/meson.build          |    1 -
 4 files changed, 51 insertions(+), 1 deletions(-)
---
diff --git a/devhelp/dh-settings-builder.c b/devhelp/dh-settings-builder.c
index af3b8a4..28edc13 100644
--- a/devhelp/dh-settings-builder.c
+++ b/devhelp/dh-settings-builder.c
@@ -20,6 +20,18 @@
 
 #include "dh-settings-builder.h"
 
+/**
+ * SECTION:dh-settings-builder
+ * @Title: DhSettingsBuilder
+ * @Short_description: Builds #DhSettings objects
+ *
+ * #DhSettingsBuilder permits to build #DhSettings objects. Once a #DhSettings
+ * object is created, it is immutable.
+ *
+ * The #GSettings schemas installed by the libdevhelp are relocatable. So the
+ * paths need to be provided.
+ */
+
 /* API design:
  *
  * Follow the builder pattern, see:
@@ -57,12 +69,25 @@ dh_settings_builder_init (DhSettingsBuilder *builder)
         builder->priv = dh_settings_builder_get_instance_private (builder);
 }
 
+/**
+ * dh_settings_builder_new:
+ *
+ * Returns: (transfer full): a new #DhSettingsBuilder.
+ * Since: 3.30
+ */
 DhSettingsBuilder *
 dh_settings_builder_new (void)
 {
         return g_object_new (DH_TYPE_SETTINGS_BUILDER, NULL);
 }
 
+/**
+ * dh_settings_builder_set_contents_path:
+ * @builder: a #DhSettingsBuilder.
+ * @contents_path: the path for the "contents" schema.
+ *
+ * Since: 3.30
+ */
 void
 dh_settings_builder_set_contents_path (DhSettingsBuilder *builder,
                                        const gchar       *contents_path)
@@ -74,6 +99,13 @@ dh_settings_builder_set_contents_path (DhSettingsBuilder *builder,
         builder->priv->contents_path = g_strdup (contents_path);
 }
 
+/**
+ * dh_settings_builder_create_object:
+ * @builder: a #DhSettingsBuilder.
+ *
+ * Returns: (transfer full): the newly created #DhSettings object.
+ * Since: 3.30
+ */
 DhSettings *
 dh_settings_builder_create_object (DhSettingsBuilder *builder)
 {
diff --git a/docs/reference/devhelp-docs.xml b/docs/reference/devhelp-docs.xml
index 87b1cf9..ed3e626 100644
--- a/docs/reference/devhelp-docs.xml
+++ b/docs/reference/devhelp-docs.xml
@@ -21,6 +21,7 @@
       <title>General</title>
       <xi:include href="xml/init.xml"/>
       <xi:include href="xml/dh-settings.xml"/>
+      <xi:include href="xml/dh-settings-builder.xml"/>
     </chapter>
 
     <chapter id="data">
diff --git a/docs/reference/devhelp-sections.txt b/docs/reference/devhelp-sections.txt
index dcd6133..ce06fa3 100644
--- a/docs/reference/devhelp-sections.txt
+++ b/docs/reference/devhelp-sections.txt
@@ -169,6 +169,24 @@ dh_settings_get_type
 </SECTION>
 
 <SECTION>
+<FILE>dh-settings-builder</FILE>
+DhSettingsBuilder
+dh_settings_builder_new
+dh_settings_builder_set_contents_path
+dh_settings_builder_create_object
+<SUBSECTION Standard>
+DH_IS_SETTINGS_BUILDER
+DH_IS_SETTINGS_BUILDER_CLASS
+DH_SETTINGS_BUILDER
+DH_SETTINGS_BUILDER_CLASS
+DH_SETTINGS_BUILDER_GET_CLASS
+DH_TYPE_SETTINGS_BUILDER
+DhSettingsBuilderClass
+DhSettingsBuilderPrivate
+dh_settings_builder_get_type
+</SECTION>
+
+<SECTION>
 <FILE>dh-sidebar</FILE>
 DhSidebar
 dh_sidebar_new
diff --git a/docs/reference/meson.build b/docs/reference/meson.build
index d80af06..ac9c213 100644
--- a/docs/reference/meson.build
+++ b/docs/reference/meson.build
@@ -15,7 +15,6 @@ GNOME.gtkdoc(
                 'dh-error.h',
                 'dh-parser.h',
                 'dh-search-context.h',
-                'dh-settings-builder.h',
                 'dh-util-lib.h'
         ],
         install : true