[devhelp/wip/swilmet/misc-improvements: 2/4] book: better document instance variables

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

commit dc2c1de51d03477950a9c5ea53a38b1ce18a6bcc
Author: Sébastien Wilmet <swilmet gnome org>
Date:   Sun May 24 14:57:58 2015 +0200

    book: better document instance variables
    
    - remove useless comments (the field name is sufficient to know what it
    is).
    - for data structures, document the type stored.

 src/dh-book.c |   16 ++++++++--------
 1 files changed, 8 insertions(+), 8 deletions(-)
---
diff --git a/src/dh-book.c b/src/dh-book.c
index 7b951e2..c4bb133 100644
--- a/src/dh-book.c
+++ b/src/dh-book.c
@@ -49,27 +49,27 @@ typedef enum {
 
 /* Structure defining basic contents to store about every book */
 typedef struct {
-        /* File path of the book */
         gchar        *path;
-        /* Enable or disabled? */
         gboolean      enabled;
-        /* Book name */
         gchar        *name;
-        /* Book title */
         gchar        *title;
-        /* Book language */
         gchar        *language;
-        /* Generated book tree */
+
+        /* The book tree of DhLink* */
         GNode        *tree;
-        /* Generated list of keywords in the book */
+
+        /* List of DhLink* */
         GList        *keywords;
-        /* Generated list of keyword completions in the book */
+
+        /* Generated list of keyword completions (gchar*) in the book */
         GList        *completions;
 
         /* Monitor of this specific book */
         GFileMonitor *monitor;
+
         /* Last received event */
         DhBookMonitorEvent monitor_event;
+
         /* ID of the event source */
         guint         monitor_event_timeout_id;
 } DhBookPrivate;