From: Matthias Clasen <mclasen@redhat.com>
Date: Sun, 28 May 2023 11:04:49 +0000 (-0400)
Subject: listitemmanager: Small docs clarifications
X-Git-Tag: archive/raspbian/4.12.3+ds-1+rpi1~1^2^2^2~22^2~1^2~207^2
X-Git-Url: https://dgit.raspbian.org/?a=commitdiff_plain;h=e9f622b81f0ff0dafcb10d62fa444516424ce1e7;p=gtk4.git

listitemmanager: Small docs clarifications

If we write docs for private functions,
lets make them relevant.
---

diff --git a/gtk/gtklistitemmanager.c b/gtk/gtklistitemmanager.c
index 3c63c70ac3..503149ea7c 100644
--- a/gtk/gtklistitemmanager.c
+++ b/gtk/gtklistitemmanager.c
@@ -1004,6 +1004,8 @@ gtk_list_item_manager_merge_list_items (GtkListItemManager *self,
  * It is not valid for either tile to have 0 items after
  * the split.
  *
+ * This function does not update the tiles' areas.
+ *
  * Returns: The new tile
  **/
 GtkListTile *
@@ -1037,10 +1039,6 @@ gtk_list_tile_split (GtkListItemManager *self,
  *
  * Note that this only looks forward, but never backward.
  *
- * A special case here are filler tiles. They only get
- * collected, when they are explicitly passed in, but never
- * otherwise.
- *
  * Returns: The next tile or NULL if everything was gc'ed
  **/
 static GtkListTile *
@@ -1093,6 +1091,15 @@ gtk_list_tile_gc (GtkListItemManager *self,
   return tile;
 }
 
+/*
+ * gtk_list_item_manager_gc_tiles:
+ * @self: the listitemmanager
+ *
+ * Removes all tiles of type GTK_LIST_TILE_REMOVED
+ * and merges item tiles as much as possible.
+ *
+ * This function does not update the tiles' areas.
+ */
 void
 gtk_list_item_manager_gc_tiles (GtkListItemManager *self)
 {