[devhelp] SearchContext: improve documentation



commit bc7fbbe99e456fa70b10d80b13712cafebdc06ac
Author: Sébastien Wilmet <swilmet gnome org>
Date:   Fri Jan 19 15:06:35 2018 +0100

    SearchContext: improve documentation

 src/dh-search-context.c |    9 +++++++--
 1 files changed, 7 insertions(+), 2 deletions(-)
---
diff --git a/src/dh-search-context.c b/src/dh-search-context.c
index 80d4fe1..3a418f2 100644
--- a/src/dh-search-context.c
+++ b/src/dh-search-context.c
@@ -19,15 +19,20 @@
 #include "dh-search-context.h"
 #include <string.h>
 
+/* DhSearchContext represents one search instance, with the search string as
+ * data.
+ */
+
 struct _DhSearchContext {
-        /* The content of the search string */
+        /* The content of the search string: */
+
         gchar *book_id;
         gchar *page_id;
 
         // If non-NULL, contains at least one non-empty string.
         GStrv keywords;
 
-        /* Derived data */
+        /* Derived data: */
 
         // The GPatternSpec's are NULL if @keywords is NULL.
         GPatternSpec *pattern_spec_prefix;


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