[gtk/ebassi/overlay-docs: 1/2] Add missing documentation for GtkOverlayLayout



commit 123fb14b9fe8428bf5d4fec921815efc161285cf
Author: Emmanuele Bassi <ebassi gnome org>
Date:   Wed May 27 15:45:38 2020 +0100

    Add missing documentation for GtkOverlayLayout
    
    We're missing the documentation for the constructor, and for the child
    properties.

 gtk/gtkoverlaylayout.c | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)
---
diff --git a/gtk/gtkoverlaylayout.c b/gtk/gtkoverlaylayout.c
index 54ed06e573..91c88a9653 100644
--- a/gtk/gtkoverlaylayout.c
+++ b/gtk/gtkoverlaylayout.c
@@ -121,12 +121,23 @@ gtk_overlay_layout_child_class_init (GtkOverlayLayoutChildClass *klass)
   gobject_class->get_property = gtk_overlay_layout_child_get_property;
   gobject_class->finalize = gtk_overlay_layout_child_finalize;
 
+  /**
+   * GtkOverlayLayoutChild:measure:
+   *
+   * Whether the child size should contribute to the #GtkOverlayLayout's
+   * measurement.
+   */
   child_props[PROP_MEASURE] =
     g_param_spec_boolean ("measure",
                           P_("Measure"),
                           P_("Include in size measurement"),
                           FALSE,
                           GTK_PARAM_READWRITE|G_PARAM_EXPLICIT_NOTIFY);
+  /**
+   * GtkOverlayLayoutChild:clip-overlay:
+   *
+   * Whether the child should be clipped to fit the parent's size.
+   */
   child_props[PROP_CLIP_OVERLAY] =
     g_param_spec_boolean ("clip-overlay",
                           P_("Clip Overlay"),
@@ -443,6 +454,13 @@ gtk_overlay_layout_init (GtkOverlayLayout *self)
 {
 }
 
+/**
+ * gtk_overlay_layout_new:
+ *
+ * Creates a new #GtkOverlayLayout instance.
+ *
+ * Returns: the newly create instance
+ */
 GtkLayoutManager *
 gtk_overlay_layout_new (void)
 {


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