[gtk/ebassi/gidocgen: 341/481] multisorter: Tweak docs




commit b516ce97add37deddaac4a0a4077b4e2c107bfc6
Author: Matthias Clasen <mclasen redhat com>
Date:   Sun Feb 28 13:10:04 2021 -0500

    multisorter: Tweak docs

 gtk/gtkmultisorter.c | 24 ++++++++++++------------
 1 file changed, 12 insertions(+), 12 deletions(-)
---
diff --git a/gtk/gtkmultisorter.c b/gtk/gtkmultisorter.c
index a733f5a275..72d686784b 100644
--- a/gtk/gtkmultisorter.c
+++ b/gtk/gtkmultisorter.c
@@ -34,12 +34,12 @@
 #include "gdk/gdkarrayimpl.c"
 
 /**
- * SECTION:gtkmultisorter
- * @Title: GtkMultiSorter
- * @Short_description: Combining multiple sorters
+ * GtkMultiSorter:
  *
- * GtkMultiSorter combines multiple sorters by trying them
- * in turn. If the first sorter compares two items as equal,
+ * `GtkMultiSorter` combines multiple sorters by trying them
+ * in turn.
+ *
+ * If the first sorter compares two items as equal,
  * the second is tried next, and so on.
  */
 struct _GtkMultiSorter
@@ -375,7 +375,7 @@ gtk_multi_sorter_init (GtkMultiSorter *self)
  * no sorter has been added to it, it will always compare
  * items as equal.
  *
- * Returns: a new #GtkMultiSorter
+ * Returns: a new `GtkMultiSorter`
  */
 GtkMultiSorter *
 gtk_multi_sorter_new (void)
@@ -385,12 +385,13 @@ gtk_multi_sorter_new (void)
 
 /**
  * gtk_multi_sorter_append:
- * @self: a #GtkMultiSorter
+ * @self: a `GtkMultiSorter`
  * @sorter: (transfer full): a sorter to add
  *
- * Add @sorter to @self to use for sorting at the end. @self
- * will consult all existing sorters before it will sort with
- * the given @sorter.
+ * Add @sorter to @self to use for sorting at the end.
+ *
+ * @self will consult all existing sorters before it will
+ * sort with the given @sorter.
  */
 void
 gtk_multi_sorter_append (GtkMultiSorter *self,
@@ -409,7 +410,7 @@ gtk_multi_sorter_append (GtkMultiSorter *self,
 
 /**
  * gtk_multi_sorter_remove:
- * @self: a #GtkMultiSorter
+ * @self: a `GtkMultiSorter`
  * @position: position of sorter to remove
  *
  * Removes the sorter at the given @position from the list of sorter
@@ -438,4 +439,3 @@ gtk_multi_sorter_remove (GtkMultiSorter *self,
                                 GTK_SORTER_CHANGE_LESS_STRICT,
                                 gtk_multi_sort_keys_new (self));
 }
-


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