Move documentation to inline comments: GtkBox

Fixes https://bugzilla.gnome.org/show_bug.cgi?id=611742

Signed-off-by: Javier Jardón <jjardon@gnome.org>

1 files changed, 22 insertions, 0 deletions

diff --git a/gtk/gtkbox.h b/gtk/gtkbox.h
index 914683b48e..038c3b1c3a 100644
--- a/gtk/gtkbox.h
+++ b/gtk/gtkbox.h
@@ -65,6 +65,28 @@ struct _GtkBoxClass
   GtkContainerClass parent_class;
 };
 
+/**
+ * GtkBoxChild:
+ * @widget: the child widget, packed into the GtkBox.
+ * @padding: the number of extra pixels to put between this child and its
+ *  neighbors, set when packed, zero by default.
+ * @expand: flag indicates whether extra space should be given to this child.
+ *  Any extra space given to the parent GtkBox is divided up among all children
+ *  with this attribute set to %TRUE; set when packed, %TRUE by default.
+ * @fill: flag indicates whether any extra space given to this child due to its
+ *  @expand attribute being set is actually allocated to the child, rather than
+ *  being used as padding around the widget; set when packed, %TRUE by default.
+ * @pack: one of #GtkPackType indicating whether the child is packed with
+ *  reference to the start (top/left) or end (bottom/right) of the GtkBox.
+ * @is_secondary: %TRUE if the child is secondary
+ *
+ * The #GtkBoxChild holds a child widget of #GtkBox and describes how the child
+ * is to be packed into the #GtkBox. All fields of this #GtkBoxChild should be
+ * considered read-only and they should never be set directly by an application.
+ * Use gtk_box_query_child_packing() and gtk_box_set_child_packing() to query
+ * and set the #GtkBoxChild.padding, #GtkBoxChild.expand, #GtkBoxChild.fill and
+ * #GtkBoxChild.pack fields.
+ */
 struct _GtkBoxChild
 {
   GtkWidget *widget;