From: Matthias Clasen <mclasen@redhat.com>
Date: Sat, 10 Dec 2022 21:36:00 +0000 (-0500)
Subject: popover: Clarify docs
X-Git-Tag: archive/raspbian/4.12.3+ds-1+rpi1~1^2^2^2~22^2~9^2~43^2
X-Git-Url: https://dgit.raspbian.org/?a=commitdiff_plain;h=5df9f4016e79e367c68d7b99740db81834bf29b2;p=gtk4.git

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 529e294092..5d005f57ca 100644
--- 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)