Merge branch 'native-layout-incubator'

[~andy/gtk] / gtk / gtkalignment.c

diff --git a/gtk/gtkalignment.c b/gtk/gtkalignment.c
index 73905f813a273596c4ef96e67c55f5a9ff11db51..5d986e2a7054fc82916cd69bead13ec1782353d5 100644 (file)
--- a/gtk/gtkalignment.c
+++ b/gtk/gtkalignment.c
@@ -24,6 +24,25 @@
  * GTK+ at ftp://ftp.gtk.org/pub/gtk/. 
  */
 
+/**
+ * SECTION:gtkalignment
+ * @Short_description: A widget which controls the alignment and size of its child
+ * @Title: GtkAlignment
+ *
+ * The #GtkAlignment widget controls the alignment and size of its child widget.
+ * It has four settings: xscale, yscale, xalign, and yalign.
+ *
+ * The scale settings are used to specify how much the child widget should
+ * expand to fill the space allocated to the #GtkAlignment.
+ * The values can range from 0 (meaning the child doesn't expand at all) to
+ * 1 (meaning the child expands to fill all of the available space).
+ *
+ * The align settings are used to place the child widget within the available
+ * area. The values range from 0 (top or left) to 1 (bottom or right).
+ * Of course, if the scale settings are both set to 1, the alignment settings
+ * have no effect.
+ */
+
 #include "config.h"
 #include "gtkalignment.h"
 #include "gtkextendedlayout.h"
@@ -223,6 +242,24 @@ gtk_alignment_init (GtkAlignment *alignment)
   priv->padding_right = 0;
 }
 
+/**
+ * gtk_alignment_new:
+ * @xalign: the horizontal alignment of the child widget, from 0 (left) to 1
+ *  (right).
+ * @yalign: the vertical alignment of the child widget, from 0 (top) to 1
+ *  (bottom).
+ * @xscale: the amount that the child widget expands horizontally to fill up
+ *  unused space, from 0 to 1.
+ *  A value of 0 indicates that the child widget should never expand.
+ *  A value of 1 indicates that the child widget will expand to fill all of the
+ *  space allocated for the #GtkAlignment.
+ * @yscale: the amount that the child widget expands vertically to fill up
+ *  unused space, from 0 to 1. The values are similar to @xscale.
+ *
+ * Creates a new #GtkAlignment.
+ *
+ * Returns: the new #GtkAlignment.
+ */
 GtkWidget*
 gtk_alignment_new (gfloat xalign,
                   gfloat yalign,
@@ -367,6 +404,23 @@ gtk_alignment_get_property (GObject         *object,
     }
 }
 
+/**
+ * gtk_alignment_set:
+ * @alignment: a #GtkAlignment.
+ * @xalign: the horizontal alignment of the child widget, from 0 (left) to 1
+ *  (right).
+ * @yalign: the vertical alignment of the child widget, from 0 (top) to 1
+ *  (bottom).
+ * @xscale: the amount that the child widget expands horizontally to fill up
+ *  unused space, from 0 to 1.
+ *  A value of 0 indicates that the child widget should never expand.
+ *  A value of 1 indicates that the child widget will expand to fill all of the
+ *  space allocated for the #GtkAlignment.
+ * @yscale: the amount that the child widget expands vertically to fill up
+ *  unused space, from 0 to 1. The values are similar to @xscale.
+ *
+ * Sets the #GtkAlignment values.
+ */
 void
 gtk_alignment_set (GtkAlignment *alignment,
                   gfloat        xalign,