[devhelp] DhLink: small doc improvements



commit 248e2a2f4569b053eb20c4fbdbd6a5113ba7bda1
Author: Sébastien Wilmet <swilmet gnome org>
Date:   Fri Dec 8 21:49:10 2017 +0100

    DhLink: small doc improvements

 src/dh-link.c |    4 ++--
 1 files changed, 2 insertions(+), 2 deletions(-)
---
diff --git a/src/dh-link.c b/src/dh-link.c
index f8bacfe..948449e 100644
--- a/src/dh-link.c
+++ b/src/dh-link.c
@@ -140,7 +140,7 @@ dh_link_new_common (DhLinkType   type,
  * @book_id: the book ID.
  * @book_title: the name of the link.
  * @relative_url: the URL relative to the book @base_path. Can contain an
- * anchor.
+ * anchor. Usually the index.html page.
  *
  * Returns: a new #DhLink of type %DH_LINK_TYPE_BOOK.
  * Since: 3.28
@@ -458,7 +458,7 @@ dh_link_get_book_title (DhLink *link)
  * dh_link_get_book_id:
  * @link: a #DhLink.
  *
- * Returns: the book ID.
+ * Returns: the ID of the book that the @link is contained in.
  */
 const gchar *
 dh_link_get_book_id (DhLink *link)


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