AuroraMiddleware/gtk2
1
0
Fork 0
forked from AuroraMiddleware/gtk
Code Issues Pull Requests Projects Releases Wiki Activity

multisorter: Tweak docs

Browse Source
This commit is contained in:
Matthias Clasen 2021-02-28 13:10:04 -05:00 committed by Emmanuele Bassi
parent 5568025f1d
commit dda6458142
1 changed files with 12 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
gtk/gtkmultisorter.c
View File

@ -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));
}