listitemmanager: Small docs clarifications
authorMatthias Clasen <mclasen@redhat.com>
Sun, 28 May 2023 11:04:49 +0000 (07:04 -0400)
committerMatthias Clasen <mclasen@redhat.com>
Sun, 28 May 2023 11:19:02 +0000 (07:19 -0400)
If we write docs for private functions,
lets make them relevant.

gtk/gtklistitemmanager.c

index 3c63c70ac3b4a2800d5eec626784d0556c0613e0..503149ea7c45d1f9fb2660beed1434a9e48747b4 100644 (file)
@@ -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)
 {