[gtk/wip/hadess/listbox-fixes] listbox: Explain behaviour of GtkListBoxCreateWidgetFunc

[Bastien Nocera <hadess src gnome org>]

commit 6b3a612bbc7cc0924bf3b8ad45ad12097f28c732
Author: Bastien Nocera <hadess hadess net>
Date:   Thu Nov 25 12:27:16 2021 +0100

    listbox: Explain behaviour of GtkListBoxCreateWidgetFunc
    
    It might be an interesting shortcut for applications to use, but it
    needs to be documented to be useful and agreed.

 gtk/gtklistbox.h | 3 +++
 1 file changed, 3 insertions(+)
---
diff --git a/gtk/gtklistbox.h b/gtk/gtklistbox.h
index 0e41498bda..68f02549f6 100644
--- a/gtk/gtklistbox.h
+++ b/gtk/gtklistbox.h
@@ -121,6 +121,9 @@ typedef void (*GtkListBoxUpdateHeaderFunc) (GtkListBoxRow *row,
  * Called for list boxes that are bound to a `GListModel` with
  * gtk_list_box_bind_model() for each item that gets added to the model.
  *
+ * If the widget returned is not a #GtkListBoxRow widget, then the widget
+ * will be inserted as the child of an intermediate #GtkListBoxRow.
+ *
  * Returns: (transfer full): a `GtkWidget` that represents @item
  */
 typedef GtkWidget * (*GtkListBoxCreateWidgetFunc) (gpointer item,