[devhelp] BookTree: update/improve class description
- From: Sébastien Wilmet <swilmet src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [devhelp] BookTree: update/improve class description
- Date: Sun, 27 Jan 2019 15:01:40 +0000 (UTC)
commit f829621f225e4b3c58c698e7fd57860f2004131f
Author: Sébastien Wilmet <swilmet gnome org>
Date: Sun Jan 27 15:56:42 2019 +0100
BookTree: update/improve class description
devhelp/dh-book-tree.c | 13 +++++++------
1 file changed, 7 insertions(+), 6 deletions(-)
---
diff --git a/devhelp/dh-book-tree.c b/devhelp/dh-book-tree.c
index 6d750b8e..64984512 100644
--- a/devhelp/dh-book-tree.c
+++ b/devhelp/dh-book-tree.c
@@ -32,15 +32,16 @@
/**
* SECTION:dh-book-tree
* @Title: DhBookTree
- * @Short_description: A #GtkTreeView containing the tree structure of all
- * enabled #DhBook's
+ * @Short_description: A #GtkTreeView containing the tree structure of a
+ * #DhBookList
*
* #DhBookTree is a #GtkTreeView (showing a tree, not a list) containing the
- * general tree structure of all enabled #DhBook's.
+ * general tree structure of the #DhBook's contained in a #DhBookList (the
+ * #DhBookList part of the provided #DhProfile).
*
- * The dh_book_get_tree() function is called to get the tree structure of a
- * #DhBook. As such the tree contains only #DhLink's of type %DH_LINK_TYPE_BOOK
- * or %DH_LINK_TYPE_PAGE.
+ * #DhBookTree calls the dh_book_get_tree() function to get the tree structure
+ * of a #DhBook. As such the tree contains only #DhLink's of type
+ * %DH_LINK_TYPE_BOOK or %DH_LINK_TYPE_PAGE.
*
* When an element is selected, the #DhBookTree::link-selected signal is
* emitted. Only one element can be selected at a time.
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]