From 62c878b0cd00c73685db8618d75d16d2d0e204bf Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Javier=20Jard=C3=B3n?= Date: Mon, 11 Apr 2011 03:04:20 +0100 Subject: [PATCH] Move documentation to inline comments: GtkHScale --- docs/reference/gtk/tmpl/.gitignore | 1 + docs/reference/gtk/tmpl/gtkhscale.sgml | 54 -------------------------- gtk/gtkhscale.c | 21 ++++++++++ 3 files changed, 22 insertions(+), 54 deletions(-) delete mode 100644 docs/reference/gtk/tmpl/gtkhscale.sgml diff --git a/docs/reference/gtk/tmpl/.gitignore b/docs/reference/gtk/tmpl/.gitignore index 469aa22f38..69350ee8d9 100644 --- a/docs/reference/gtk/tmpl/.gitignore +++ b/docs/reference/gtk/tmpl/.gitignore @@ -35,6 +35,7 @@ gtkfilefilter.sgml gtkfontbutton.sgml gtkhbox.sgml gtkhpaned.sgml +gtkhscale.sgml gtkhscrollbar.sgml gtkiconview.sgml gtkimagemenuitem.sgml diff --git a/docs/reference/gtk/tmpl/gtkhscale.sgml b/docs/reference/gtk/tmpl/gtkhscale.sgml deleted file mode 100644 index 8616ef83c7..0000000000 --- a/docs/reference/gtk/tmpl/gtkhscale.sgml +++ /dev/null @@ -1,54 +0,0 @@ - -GtkHScale - - -A horizontal slider widget for selecting a value from a range - - - -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. - - - - - - - - - - - - - - - -The #GtkHScale-struct struct contains private data only, and -should be accessed using the functions below. - - - - - -Creates a new #GtkHScale. - - -@adjustment: the #GtkAdjustment which sets the range of the scale. -@Returns: a new #GtkHScale. - - - - - - - -@min: -@max: -@step: -@Returns: - - diff --git a/gtk/gtkhscale.c b/gtk/gtkhscale.c index a8b86e459d..84ea86a6b1 100644 --- a/gtk/gtkhscale.c +++ b/gtk/gtkhscale.c @@ -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) {