Commit 1f50a4d0 authored by Javier Jardón's avatar Javier Jardón

Move documentation to inline comments: GtkHSeparator

parent 1f9f5e88
...@@ -39,6 +39,7 @@ gtkhbox.sgml ...@@ -39,6 +39,7 @@ gtkhbox.sgml
gtkhpaned.sgml gtkhpaned.sgml
gtkhscale.sgml gtkhscale.sgml
gtkhscrollbar.sgml gtkhscrollbar.sgml
gtkhseparator.sgml
gtkiconview.sgml gtkiconview.sgml
gtkimagemenuitem.sgml gtkimagemenuitem.sgml
gtkimcontext.sgml gtkimcontext.sgml
......
<!-- ##### SECTION Title ##### -->
GtkHSeparator
<!-- ##### SECTION Short_Description ##### -->
A horizontal separator
<!-- ##### SECTION Long_Description ##### -->
<para>
The #GtkHSeparator widget is a horizontal separator, used to group the
widgets within a window. It displays a horizontal line with a shadow to
make it appear sunken into the interface.
</para>
<note>
<para>
The #GtkHSeparator widget is not used as a separator within menus.
To create a separator in a menu create an empty #GtkSeparatorMenuItem
widget using gtk_separator_menu_item_new() and add it to the menu with
gtk_menu_shell_append().
</para>
</note>
<!-- ##### SECTION See_Also ##### -->
<para>
<variablelist>
<varlistentry>
<term>#GtkVSeparator</term>
<listitem><para>a vertical separator.</para></listitem>
</varlistentry>
</variablelist>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### SECTION Image ##### -->
<!-- ##### STRUCT GtkHSeparator ##### -->
<para>
The #GtkHSeparator-struct struct contains private data only, and
should be accessed using the functions below.
</para>
<!-- ##### FUNCTION gtk_hseparator_new ##### -->
<para>
Creates a new #GtkHSeparator.
</para>
@void:
@Returns: a new #GtkHSeparator.
...@@ -30,6 +30,25 @@ ...@@ -30,6 +30,25 @@
#include "gtkorientable.h" #include "gtkorientable.h"
/**
* SECTION:gtkhseparator
* @Short_description: A horizontal separator
* @Title: GtkHSeparator
* @See_also: #GtkSeparator
*
* The #GtkHSeparator widget is a horizontal separator, used to group the
* widgets within a window. It displays a horizontal line with a shadow to
* make it appear sunken into the interface.
*
* <note>
* The #GtkHSeparator widget is not used as a separator within menus.
* To create a separator in a menu create an empty #GtkSeparatorMenuItem
* widget using gtk_separator_menu_item_new() and add it to the menu with
* gtk_menu_shell_append().
* </note>
*/
G_DEFINE_TYPE (GtkHSeparator, gtk_hseparator, GTK_TYPE_SEPARATOR) G_DEFINE_TYPE (GtkHSeparator, gtk_hseparator, GTK_TYPE_SEPARATOR)
static void static void
...@@ -44,6 +63,13 @@ gtk_hseparator_init (GtkHSeparator *hseparator) ...@@ -44,6 +63,13 @@ gtk_hseparator_init (GtkHSeparator *hseparator)
GTK_ORIENTATION_HORIZONTAL); GTK_ORIENTATION_HORIZONTAL);
} }
/**
* gtk_hseparator_new:
*
* Creates a new #GtkHSeparator.
*
* Returns: a new #GtkHSeparator.
*/
GtkWidget * GtkWidget *
gtk_hseparator_new (void) gtk_hseparator_new (void)
{ {
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment