summaryrefslogtreecommitdiff
path: root/gtk/gtkmultifilter.c
diff options
context:
space:
mode:
authorMatthias Clasen <mclasen@redhat.com>2021-02-27 10:52:22 -0500
committerEmmanuele Bassi <ebassi@gnome.org>2021-03-11 16:37:34 +0000
commit7dd436ab17ba4bd86b86b5e42b03fd2ce7161574 (patch)
treed43ef7d7c52c6376bb20a5e5af7e1ab1412bc0af /gtk/gtkmultifilter.c
parent085b0b7c08c07aa3142e15cd1cfe53e95063c66e (diff)
downloadgtk+-7dd436ab17ba4bd86b86b5e42b03fd2ce7161574.tar.gz
filter: Add sections for AnyFilter and EveryFilter
Diffstat (limited to 'gtk/gtkmultifilter.c')
-rw-r--r--gtk/gtkmultifilter.c52
1 files changed, 29 insertions, 23 deletions
diff --git a/gtk/gtkmultifilter.c b/gtk/gtkmultifilter.c
index 3550d90c58..1d68c0bce1 100644
--- a/gtk/gtkmultifilter.c
+++ b/gtk/gtkmultifilter.c
@@ -35,19 +35,24 @@
/*** MULTI FILTER ***/
/**
- * SECTION:gtkmultifilter
- * @Title: GtkMultiFilter
- * @Short_description: Combining multiple filters
+ * GtkMultiFilter:
*
- * GtkMultiFilter is the base type that implements support for handling
+ * `GtkMultiFilter` is the base type that implements support for handling
* multiple filters.
+ */
+
+/**
+ * GtkAnyFilter:
*
- * GtkAnyFilter is a subclass of GtkMultiFilter that matches an item
- * when at least one of its filters matches.
+ * `GtkAnyFilter` matches an item when at least one of its filters matches.
+ */
+
+/**
+ * GtkEveryFilter:
*
- * GtkEveryFilter is a subclass of GtkMultiFilter that matches an item
- * when each of its filters matches.
+ * `GtkEveryFilter` matches an item when each of its filters matches.
*/
+
struct _GtkMultiFilter
{
GtkFilter parent_instance;
@@ -164,11 +169,11 @@ gtk_multi_filter_init (GtkMultiFilter *self)
/**
* gtk_multi_filter_append:
- * @self: a #GtkMultiFilter
+ * @self: a `GtkMultiFilter`
* @filter: (transfer full): A new filter to use
*
* Adds a @filter to @self to use for matching.
- **/
+ */
void
gtk_multi_filter_append (GtkMultiFilter *self,
GtkFilter *filter)
@@ -185,11 +190,12 @@ gtk_multi_filter_append (GtkMultiFilter *self,
/**
* gtk_multi_filter_remove:
- * @self: a #GtkMultiFilter
+ * @self: a `GtkMultiFilter`
* @position: position of filter to remove
*
* Removes the filter at the given @position from the list of filters used
* by @self.
+ *
* If @position is larger than the number of filters, nothing happens and
* the function returns.
**/
@@ -295,15 +301,15 @@ gtk_any_filter_init (GtkAnyFilter *self)
* gtk_any_filter_new:
*
* Creates a new empty "any" filter.
- * Use gtk_multi_filter_append() to add filters to it.
+ *
+ * Use [method@Gtk.MultiFilter.append] to add filters to it.
*
* This filter matches an item if any of the filters added to it
- * matches the item.
- * In particular, this means that if no filter has been added to
- * it, the filter matches no item.
+ * matches the item. In particular, this means that if no filter
+ * has been added to it, the filter matches no item.
*
- * Returns: a new #GtkAnyFilter
- **/
+ * Returns: a new `GtkAnyFilter`
+ */
GtkAnyFilter *
gtk_any_filter_new (void)
{
@@ -393,15 +399,15 @@ gtk_every_filter_init (GtkEveryFilter *self)
* gtk_every_filter_new:
*
* Creates a new empty "every" filter.
- * Use gtk_multi_filter_append() to add filters to it.
+ *
+ * Use [method@Gtk.MultiFilter.append] to add filters to it.
*
* This filter matches an item if each of the filters added to it
- * matches the item.
- * In particular, this means that if no filter has been added to
- * it, the filter matches every item.
+ * matches the item. In particular, this means that if no filter
+ * has been added to it, the filter matches every item.
*
- * Returns: a new #GtkEveryFilter
- **/
+ * Returns: a new `GtkEveryFilter`
+ */
GtkEveryFilter *
gtk_every_filter_new (void)
{