[devhelp] docs: write class description for DhAssistantView



commit 848f01b06221fc03348b74650b93a3638dbe43ea
Author: Sébastien Wilmet <swilmet gnome org>
Date:   Sun May 7 15:47:16 2017 +0200

    docs: write class description for DhAssistantView

 docs/reference/devhelp-sections.txt |    1 -
 src/dh-assistant-view.c             |   15 +++++++++++++++
 2 files changed, 15 insertions(+), 1 deletions(-)
---
diff --git a/docs/reference/devhelp-sections.txt b/docs/reference/devhelp-sections.txt
index a994e69..806f33b 100644
--- a/docs/reference/devhelp-sections.txt
+++ b/docs/reference/devhelp-sections.txt
@@ -7,7 +7,6 @@ dh_free_resources
 
 <SECTION>
 <FILE>dh-assistant-view</FILE>
-<TITLE>DhAssistantView</TITLE>
 DhAssistantView
 dh_assistant_view_new
 dh_assistant_view_set_link
diff --git a/src/dh-assistant-view.c b/src/dh-assistant-view.c
index 4baaa8c..f096b07 100644
--- a/src/dh-assistant-view.c
+++ b/src/dh-assistant-view.c
@@ -27,6 +27,21 @@
 #include "dh-book.h"
 #include "dh-book-manager.h"
 
+/**
+ * SECTION:dh-assistant-view
+ * @Title: DhAssistantView
+ * @Short_description: A small “assistant” widget for displaying just one hit
+ *
+ * #DhAssistantView is a subclass of #WebKitWebView for displaying the
+ * documentation of just one symbol.
+ *
+ * A possible use-case: in a text editor, pressing a keyboard shortcut could
+ * display this widget for the symbol under the cursor.
+ *
+ * With the Devhelp application, an assistant can easily be launched with the
+ * command line option `--search-assistant`.
+ */
+
 typedef struct {
         DhLink *link;
         gchar *current_search;


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