Move documentation to inline comments: GtkVBox

Fixes https://bugzilla.gnome.org/show_bug.cgi?id=611831
This commit is contained in:
Steven Harms 2010-03-04 13:21:16 -05:00 committed by Javier Jardón
parent a5e496cf87
commit 3f579a7a93
2 changed files with 23 additions and 49 deletions

View File

@ -1,49 +0,0 @@
<!-- ##### SECTION Title ##### -->
GtkVBox
<!-- ##### SECTION Short_Description ##### -->
A vertical container box
<!-- ##### SECTION Long_Description ##### -->
<para>
GtkVBox is a container that organizes child widgets into a single column.
</para>
<para>
Use the #GtkBox packing interface to determine the arrangement,
spacing, height, and alignment of GtkVBox children.
</para>
<para>
All children are allocated the same width.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
<variablelist>
<varlistentry>
<term>#GtkHBox</term>
<listitem><para>a sister class that organizes widgets into a row.</para></listitem>
</varlistentry>
</variablelist>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT GtkVBox ##### -->
<!-- ##### FUNCTION gtk_vbox_new ##### -->
<para>
Creates a new GtkVBox.
</para>
@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.

View File

@ -30,6 +30,20 @@
#include "gtkvbox.h" #include "gtkvbox.h"
#include "gtkalias.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) G_DEFINE_TYPE (GtkVBox, gtk_vbox, GTK_TYPE_BOX)
static void static void
@ -46,6 +60,15 @@ gtk_vbox_init (GtkVBox *vbox)
_gtk_box_set_old_defaults (GTK_BOX (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 * GtkWidget *
gtk_vbox_new (gboolean homogeneous, gtk_vbox_new (gboolean homogeneous,
gint spacing) gint spacing)