[devhelp] Book: improve a little the docs wrt the path
- From: Sébastien Wilmet <swilmet src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [devhelp] Book: improve a little the docs wrt the path
- Date: Wed, 10 May 2017 15:40:12 +0000 (UTC)
commit d79c6f46ae823c35e10d495a3e1413a9cd84f71a
Author: Sébastien Wilmet <swilmet gnome org>
Date: Wed May 10 17:25:54 2017 +0200
Book: improve a little the docs wrt the path
src/dh-book.c | 6 +++---
1 files changed, 3 insertions(+), 3 deletions(-)
---
diff --git a/src/dh-book.c b/src/dh-book.c
index 4f33eba..6f129c1 100644
--- a/src/dh-book.c
+++ b/src/dh-book.c
@@ -288,7 +288,7 @@ book_monitor_event_cb (GFileMonitor *file_monitor,
/**
* dh_book_new:
- * @book_path: the path of the book
+ * @book_path: the path to the index file.
*
* Returns: a new #DhBook object.
*/
@@ -505,7 +505,7 @@ dh_book_get_language (DhBook *book)
* dh_book_get_path:
* @book: a #DhBook.
*
- * Returns: the book path.
+ * Returns: the path to the index file.
*/
const gchar *
dh_book_get_path (DhBook *book)
@@ -566,7 +566,7 @@ dh_book_set_enabled (DhBook *book,
* @a: a #DhBook.
* @b: a #DhBook.
*
- * Compares the #DhBook's by their paths.
+ * Compares the #DhBook's by their path to the index file.
*
* Returns: an integer less than, equal to, or greater than zero, if @a is <, ==
* or > than @b.
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]