popover: Clarify docs

gtk_popover_present() is a misleadingly named
function, so at least give it clear docs that
tell people to use gtk_popover_popup() instead.

diff --git a/gtk/gtkpopover.c b/gtk/gtkpopover.c
index 529e2940922306364b7bd22dbfeacddb815409c5..5d005f57cada4c7be2b0a35f2edffa280a72ed0b 100644 (file)
--- a/gtk/gtkpopover.c
+++ b/gtk/gtkpopover.c
@@ -598,7 +598,13 @@ present_popup (GtkPopover *popover)
  * gtk_popover_present:
  * @popover: a `GtkPopover`
  *
- * Presents the popover to the user.
+ * Allocate a size for the `GtkPopover`.
+ *
+ * This function needs to be called in size-allocate by widgets
+ * who have a `GtkPopover` as child. When using a layout manager,
+ * this is happening automatically.
+ *
+ * To make a popover appear on screen, use [method@Gtk.Popover.popup].
  */
 void
 gtk_popover_present (GtkPopover *popover)