Move documentation to inline comments: GtkVSeparator

Fixes https://bugzilla.gnome.org/show_bug.cgi?id=611662
This commit is contained in:
Steven Harms 2010-03-03 18:35:45 -05:00 committed by Javier Jardón
parent f0f3b01876
commit 15d1d8bb3b
3 changed files with 24 additions and 41 deletions

View File

@ -1,41 +0,0 @@
<!-- ##### SECTION Title ##### -->
GtkVSeparator
<!-- ##### SECTION Short_Description ##### -->
A vertical separator
<!-- ##### SECTION Long_Description ##### -->
<para>
The #GtkVSeparator widget is a vertical separator, used to group the
widgets within a window. It displays a vertical line with a shadow to
make it appear sunken into the interface.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
<variablelist>
<varlistentry>
<term>#GtkHSeparator</term>
<listitem><para>a horizontal separator.</para></listitem>
</varlistentry>
</variablelist>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT GtkVSeparator ##### -->
<para>
The #GtkVSeparator-struct struct contains private data only, and
should be accessed using the functions below.
</para>
<!-- ##### FUNCTION gtk_vseparator_new ##### -->
<para>
Creates a new #GtkVSeparator.
</para>
@Returns: a new #GtkVSeparator.

View File

@ -30,6 +30,17 @@
#include "gtkvseparator.h" #include "gtkvseparator.h"
#include "gtkalias.h" #include "gtkalias.h"
/**
* SECTION:gtkvseparator
* @Short_description: A vertical separator
* @Title: GtkVSeparator
* @See_also: #GtkHSeparator
*
* The #GtkVSeparator widget is a vertical separator, used to group the
* widgets within a window. It displays a vertical line with a shadow to
* make it appear sunken into the interface.
*/
G_DEFINE_TYPE (GtkVSeparator, gtk_vseparator, GTK_TYPE_SEPARATOR) G_DEFINE_TYPE (GtkVSeparator, gtk_vseparator, GTK_TYPE_SEPARATOR)
static void static void
@ -44,6 +55,13 @@ gtk_vseparator_init (GtkVSeparator *vseparator)
GTK_ORIENTATION_VERTICAL); GTK_ORIENTATION_VERTICAL);
} }
/**
* gtk_vseparator_new:
*
* Creates a new #GtkVSeparator.
*
* Returns: a new #GtkVSeparator.
*/
GtkWidget * GtkWidget *
gtk_vseparator_new (void) gtk_vseparator_new (void)
{ {

View File

@ -49,6 +49,12 @@ G_BEGIN_DECLS
typedef struct _GtkVSeparator GtkVSeparator; typedef struct _GtkVSeparator GtkVSeparator;
typedef struct _GtkVSeparatorClass GtkVSeparatorClass; typedef struct _GtkVSeparatorClass GtkVSeparatorClass;
/**
* GtkVSeparator:
*
* The #GtkVSeparator struct contains private data only, and
* should be accessed using the functions below.
*/
struct _GtkVSeparator struct _GtkVSeparator
{ {
GtkSeparator separator; GtkSeparator separator;