[gtk/present-toplevel-2: 175/178] popuplayout: Add docs



commit 92c5a91b1cc8a4da87a0ea7c81f7e9f1c03d4eb8
Author: Matthias Clasen <mclasen redhat com>
Date:   Mon Mar 9 13:36:38 2020 -0700

    popuplayout: Add docs

 gdk/gdkpopuplayout.c | 14 ++++++++++++++
 1 file changed, 14 insertions(+)
---
diff --git a/gdk/gdkpopuplayout.c b/gdk/gdkpopuplayout.c
index f612efb727..25f16c5e8a 100644
--- a/gdk/gdkpopuplayout.c
+++ b/gdk/gdkpopuplayout.c
@@ -22,6 +22,16 @@
 
 #include "gdksurface.h"
 
+/**
+ * SECTION:gdkpopuplayout
+ * @Title: GdkPopupLayout
+ * @Short_description: Information for presenting popups
+ *
+ * Popups are positioned relative to their parent surface.
+ * The GdkPopupLayout struct contains information that is
+ * necessary to do so.
+ */
+
 struct _GdkPopupLayout
 {
   /* < private >*/
@@ -200,6 +210,8 @@ gdk_popup_layout_set_rect_anchor (GdkPopupLayout *layout,
  * gdk_popup_layout_get_rect_anchor:
  * @layout: a #GdkPopupLayout
  *
+ * Returns the anchor position on the anchor rectangle.
+ *
  * Returns: the anchor on the anchor rectangle.
  */
 GdkGravity
@@ -226,6 +238,8 @@ gdk_popup_layout_set_surface_anchor (GdkPopupLayout *layout,
  * gdk_popup_layout_get_surface_anchor:
  * @layout: a #GdkPopupLayout
  *
+ * Returns the anchor position on the popup surface.
+ *
  * Returns: the anchor on the popup surface.
  */
 GdkGravity


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]