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



commit 3be96759195a04e21e6b80d8d82fe02741648307
Author: Sébastien Wilmet <swilmet gnome org>
Date:   Sun May 24 13:31:49 2015 +0200

    book-manager: better document instance variables
    
    It's important to know the types stored in the data structures.
    
    Also, space out the different fields, for clarity.

 src/dh-book-manager.c |   13 +++++++++----
 1 files changed, 9 insertions(+), 4 deletions(-)
---
diff --git a/src/dh-book-manager.c b/src/dh-book-manager.c
index bef259e..0ce8c1d 100644
--- a/src/dh-book-manager.c
+++ b/src/dh-book-manager.c
@@ -38,16 +38,21 @@ typedef struct {
 } NewPossibleBookData;
 
 typedef struct {
-        /* The list of all DhBooks found in the system */
+        /* The list of all DhBooks* found in the system */
         GList      *books;
-        /* HT with the monitors setup */
+
+        /* GFile* -> GFileMonitor* */
         GHashTable *monitors;
-        /* List of book names currently disabled */
+
+        /* List of book names (gchar*) currently disabled */
         GSList     *books_disabled;
+
         /* Whether books should be grouped by language */
         gboolean    group_by_language;
-        /* List of programming languages with at least one book enabled */
+
+        /* List of DhLanguage* with at least one book enabled */
         GList      *languages;
+
         DhSettings *settings;
 } DhBookManagerPrivate;
 


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]