[gtk/prop-list: 211/224] filter: Small doc tweaks
- From: Matthias Clasen <matthiasc src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gtk/prop-list: 211/224] filter: Small doc tweaks
- Date: Sun, 8 Dec 2019 05:41:52 +0000 (UTC)
commit 2179570e751b86bc754f1a2cf72cf2cc2c9f17c3
Author: Matthias Clasen <mclasen redhat com>
Date: Wed Dec 4 10:25:43 2019 -0500
filter: Small doc tweaks
gtk/gtkfilter.c | 16 +++++++++-------
1 file changed, 9 insertions(+), 7 deletions(-)
---
diff --git a/gtk/gtkfilter.c b/gtk/gtkfilter.c
index e3cf41ca49..db1bb3a8da 100644
--- a/gtk/gtkfilter.c
+++ b/gtk/gtkfilter.c
@@ -26,8 +26,8 @@
/**
* SECTION:gtkfilter
- * @Short_description: Filtering items in GTK
* @Title: GtkFilter
+ * @Short_description: Filtering items in GTK
* @See_also: #GtkFilerListModel
*
* #GtkFilter is the way to describe filters to be used in #GtkFilterListModel.
@@ -37,7 +37,7 @@
* visible that the function returns %TRUE for.
*
* Filters may change what items they match through their lifetime. In that
- * case they can call gtk_filter_changed() which will emit the GtkFilter:changed
+ * case, they can call gtk_filter_changed() which will emit the #GtkFilter:changed
* signal to notify that previous filter results are no longer valid and that
* items should be checked via gtk_filter_match() again.
*
@@ -89,8 +89,10 @@ gtk_filter_class_init (GtkFilterClass *class)
* This signal is emitted whenever the filter changed. Users of the filter
* should then check items again via gtk_filter_match().
*
- * Depending on the @change variable, not all items need to be changed, but
- * only some. Refer to the #GtkFilterChange documentation for details on that.
+ * #GtkFilterListModel handles this signal automatically.
+ *
+ * Depending on the @change parameter, not all items need to be changed, but
+ * only some. Refer to the #GtkFilterChange documentation for details.
*/
signals[CHANGED] =
g_signal_new (I_("changed"),
@@ -158,12 +160,12 @@ gtk_filter_get_strictness (GtkFilter *self)
* @self: a #GtkFilter
* @change: How the filter changed
*
- * Emits the GtkFilter:changed signal to notify all users of the filter that
+ * Emits the #GtkFilter:changed signal to notify all users of the filter that
* the filter changed. Users of the filter should then check items again via
* gtk_filter_match().
*
- * Depending on the @change variable, not all items need to be changed, but
- * only some. Refer to the #GtkFilterChange documentation for details on that.
+ * Depending on the @change parameter, not all items need to be changed, but
+ * only some. Refer to the #GtkFilterChange documentation for details.
*
* This function is intended for implementors of #GtkFilter subclasses and
* should not be called from other functions.
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]