Move documentation to inline comments: GtkHScale

This commit is contained in:
Javier Jardón 2011-04-11 03:04:20 +01:00
parent 610d46d12e
commit 62c878b0cd
3 changed files with 22 additions and 54 deletions

View File

@ -35,6 +35,7 @@ gtkfilefilter.sgml
gtkfontbutton.sgml
gtkhbox.sgml
gtkhpaned.sgml
gtkhscale.sgml
gtkhscrollbar.sgml
gtkiconview.sgml
gtkimagemenuitem.sgml

View File

@ -1,54 +0,0 @@
<!-- ##### SECTION Title ##### -->
GtkHScale
<!-- ##### SECTION Short_Description ##### -->
A horizontal slider widget for selecting a value from a range
<!-- ##### SECTION Long_Description ##### -->
<para>
The #GtkHScale widget is used to allow the user to select a value using
a horizontal slider. To create one, use gtk_hscale_new_with_range().
</para>
<para>
The position to show the current value, and the number of decimal places
shown can be set using the parent #GtkScale class's functions.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### SECTION Image ##### -->
<!-- ##### STRUCT GtkHScale ##### -->
<para>
The #GtkHScale-struct struct contains private data only, and
should be accessed using the functions below.
</para>
<!-- ##### FUNCTION gtk_hscale_new ##### -->
<para>
Creates a new #GtkHScale.
</para>
@adjustment: the #GtkAdjustment which sets the range of the scale.
@Returns: a new #GtkHScale.
<!-- ##### FUNCTION gtk_hscale_new_with_range ##### -->
<para>
</para>
@min:
@max:
@step:
@Returns:

View File

@ -33,6 +33,19 @@
#include "gtkorientable.h"
/**
* SECTION:gtkhscale
* @Short_description: A horizontal slider widget for selecting a value from a range
* @Title: GtkHScale
*
* The #GtkHScale widget is used to allow the user to select a value using
* a horizontal slider. To create one, use gtk_hscale_new_with_range().
*
* The position to show the current value, and the number of decimal places
* shown can be set using the parent #GtkScale class's functions.
*/
G_DEFINE_TYPE (GtkHScale, gtk_hscale, GTK_TYPE_SCALE)
static void
@ -50,6 +63,14 @@ gtk_hscale_init (GtkHScale *hscale)
GTK_ORIENTATION_HORIZONTAL);
}
/**
* gtk_hscale_new:
* @adjustment: the #GtkAdjustment which sets the range of the scale.
*
* Creates a new #GtkHScale.
*
* Returns: a new #GtkHScale.
*/
GtkWidget *
gtk_hscale_new (GtkAdjustment *adjustment)
{