From 3f579a7a936b9b6cbd08aa2331eae932b1a68491 Mon Sep 17 00:00:00 2001 From: Steven Harms Date: Thu, 4 Mar 2010 13:21:16 -0500 Subject: [PATCH] Move documentation to inline comments: GtkVBox Fixes https://bugzilla.gnome.org/show_bug.cgi?id=611831 --- docs/reference/gtk/tmpl/gtkvbox.sgml | 49 ---------------------------- gtk/gtkvbox.c | 23 +++++++++++++ 2 files changed, 23 insertions(+), 49 deletions(-) delete mode 100644 docs/reference/gtk/tmpl/gtkvbox.sgml diff --git a/docs/reference/gtk/tmpl/gtkvbox.sgml b/docs/reference/gtk/tmpl/gtkvbox.sgml deleted file mode 100644 index 0acfd568f6..0000000000 --- a/docs/reference/gtk/tmpl/gtkvbox.sgml +++ /dev/null @@ -1,49 +0,0 @@ - -GtkVBox - - -A vertical container box - - - -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. - - - - - - - -#GtkHBox -a sister class that organizes widgets into a row. - - - - - - - - - - - - - - -Creates a new GtkVBox. - - -@homogeneous: %TRUE if all children are to be given equal space allotments. -@spacing: the number of pixels to place by default between children. -@Returns: a new GtkVBox. - - 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)