[devhelp] KeywordModel: fix gtk-doc comment for filter() function
- From: SĂŠbastien Wilmet <swilmet src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [devhelp] KeywordModel: fix gtk-doc comment for filter() function
- Date: Sun, 30 Apr 2017 08:57:36 +0000 (UTC)
commit 2ff88ad71a5aa05032e1329e58e325a277dbd2fc
Author: SĂŠbastien Wilmet <swilmet gnome org>
Date: Sun Apr 30 10:51:00 2017 +0200
KeywordModel: fix gtk-doc comment for filter() function
@language is not used by Devhelp itself, it is always NULL. I haven't
tried to see what it does exactly, it's better no documentation at all
than wrong documentation.
src/dh-keyword-model.c | 13 ++++++-------
1 files changed, 6 insertions(+), 7 deletions(-)
---
diff --git a/src/dh-keyword-model.c b/src/dh-keyword-model.c
index 29361fb..58ea51c 100644
--- a/src/dh-keyword-model.c
+++ b/src/dh-keyword-model.c
@@ -981,15 +981,14 @@ set_keywords_list (DhKeywordModel *model,
* dh_keyword_model_filter:
* @model: a #DhKeywordModel.
* @search_string: a search query.
- * @book_id: (nullable): the id of a specific book or %NULL for all books.
- * @language: (nullable): the name of a programming language or %NULL for all
- * languages.
+ * @book_id: (nullable): the ID of the book currently selected, or %NULL.
+ * @language: (nullable):
*
- * Searches in the #DhBookManager the list of #DhLink's that correspond to the
- * given critera, and fills the @model with that list.
+ * Searches in the #DhBookManager the list of #DhLink's that correspond to
+ * @search_string, and fills the @model with that list.
*
- * Returns: (nullable) (transfer none): the #DhLink that corresponds exactly to
- * the given criteria, or %NULL if there is no such #DhLink.
+ * Returns: (nullable) (transfer none): the #DhLink that matches exactly
+ * @search_string, or %NULL if there is no such #DhLink.
*/
DhLink *
dh_keyword_model_filter (DhKeywordModel *model,
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]