summaryrefslogtreecommitdiff
path: root/gtk/gtkvbox.c
diff options
context:
space:
mode:
authorSteven Harms <sharms@ubuntu.com>2010-03-04 13:21:16 -0500
committerJavier Jardón <jjardon@gnome.org>2010-03-05 05:25:07 +0100
commit3f579a7a936b9b6cbd08aa2331eae932b1a68491 (patch)
tree65f9eb9645bb9b4ab955ac46507005599ce638a4 /gtk/gtkvbox.c
parenta5e496cf87f46a5fe186d9346de9898b655ad221 (diff)
downloadgtk+-3f579a7a936b9b6cbd08aa2331eae932b1a68491.tar.gz
Move documentation to inline comments: GtkVBox
Fixes https://bugzilla.gnome.org/show_bug.cgi?id=611831
Diffstat (limited to 'gtk/gtkvbox.c')
-rw-r--r--gtk/gtkvbox.c23
1 files changed, 23 insertions, 0 deletions
diff --git a/gtk/gtkvbox.c b/gtk/gtkvbox.c
index 4fcd284d6c..d87002699b 100644
--- a/gtk/gtkvbox.c
+++ b/gtk/gtkvbox.c
@@ -30,6 +30,20 @@
#include "gtkvbox.h"
#include "gtkalias.h"
+/**
+ * SECTION:gtkvbox
+ * @Short_description: A vertical container box
+ * @Title: GtkVBox
+ * @See_also: #GtkHBox
+ *
+ * A #GtkVBox is a container that organizes child widgets into a single column.
+ *
+ * Use the #GtkBox packing interface to determine the arrangement,
+ * spacing, height, and alignment of #GtkVBox children.
+ *
+ * All children are allocated the same width.
+ */
+
G_DEFINE_TYPE (GtkVBox, gtk_vbox, GTK_TYPE_BOX)
static void
@@ -46,6 +60,15 @@ gtk_vbox_init (GtkVBox *vbox)
_gtk_box_set_old_defaults (GTK_BOX (vbox));
}
+/**
+ * gtk_vbox_new:
+ * @homogeneous: %TRUE if all children are to be given equal space allotments.
+ * @spacing: the number of pixels to place by default between children.
+ *
+ * Creates a new #GtkVBox.
+ *
+ * Returns: a new #GtkVBox.
+ */
GtkWidget *
gtk_vbox_new (gboolean homogeneous,
gint spacing)