[devhelp] docs: write class descriptions for "the data" part

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

commit 9f20444a081a9ca1ee8c690316811336715b7483
Author: Sébastien Wilmet <swilmet gnome org>
Date:   Sat May 6 19:29:11 2017 +0200

    docs: write class descriptions for "the data" part

 docs/reference/devhelp-sections.txt |    3 ---
 src/dh-book-manager.c               |    8 ++++++++
 src/dh-book.c                       |   11 +++++++++++
 src/dh-link.c                       |   12 ++++++++++++
 4 files changed, 31 insertions(+), 3 deletions(-)
---
diff --git a/docs/reference/devhelp-sections.txt b/docs/reference/devhelp-sections.txt
index 45b9da6..0c353c4 100644
--- a/docs/reference/devhelp-sections.txt
+++ b/docs/reference/devhelp-sections.txt
@@ -25,7 +25,6 @@ dh_assistant_view_get_type
 
 <SECTION>
 <FILE>dh-book</FILE>
-<TITLE>DhBook</TITLE>
 DhBook
 dh_book_new
 dh_book_get_keywords
@@ -53,7 +52,6 @@ dh_book_get_type
 
 <SECTION>
 <FILE>dh-book-manager</FILE>
-<TITLE>DhBookManager</TITLE>
 DhBookManager
 dh_book_manager_new
 dh_book_manager_get_singleton
@@ -108,7 +106,6 @@ dh_keyword_model_get_type
 
 <SECTION>
 <FILE>dh-link</FILE>
-<TITLE>DhLink</TITLE>
 DhLink
 DhLinkType
 DhLinkFlags
diff --git a/src/dh-book-manager.c b/src/dh-book-manager.c
index aac0597..c1c94d4 100644
--- a/src/dh-book-manager.c
+++ b/src/dh-book-manager.c
@@ -27,6 +27,14 @@
 #include "dh-language.h"
 #include "dh-settings.h"
 
+/**
+ * SECTION:dh-book-manager
+ * @Title: DhBookManager
+ * @Short_description: Aggregation of all #DhBook's
+ *
+ * #DhBookManager is a singleton class containing all the #DhBook's.
+ */
+
 #define NEW_POSSIBLE_BOOK_TIMEOUT_SECS 5
 
 typedef struct {
diff --git a/src/dh-book.c b/src/dh-book.c
index 14e8cbd..e6765de 100644
--- a/src/dh-book.c
+++ b/src/dh-book.c
@@ -28,6 +28,17 @@
 #include "dh-parser.h"
 #include "dh-util.h"
 
+/**
+ * SECTION:dh-book
+ * @Title: DhBook
+ * @Short_description: A book, usually the documentation for one library
+ *
+ * A #DhBook usually contains the documentation for one library (or
+ * application), for example GLib or GTK+. There is one #DhBook for each index
+ * file found and parsed (an index file is a file with the extension `*.devhelp`
+ * or `*.devhelp2`).
+ */
+
 /* Timeout to wait for new events in the book so that
  * they are merged and we don't spam unneeded signals */
 #define EVENT_MERGE_TIMEOUT_SECS 2
diff --git a/src/dh-link.c b/src/dh-link.c
index 547af54..0a2b6ee 100644
--- a/src/dh-link.c
+++ b/src/dh-link.c
@@ -22,6 +22,18 @@
 #include <string.h>
 #include <glib/gi18n-lib.h>
 
+/**
+ * SECTION:dh-link
+ * @Title: DhLink
+ * @Short_description: A link inside a #DhBook
+ *
+ * A #DhLink represents a link to an HTML page or somewhere inside a page (with
+ * an anchor) that is inside a #DhBook. The link can point to a specific symbol,
+ * or a page, or the #DhBook itself.
+ *
+ * A #DhLink has a type that can be retrieved with dh_link_get_link_type().
+ */
+
 struct _DhLink {
         /* FIXME: Those two could exist only for book to save some
          * memory.