[gtk+] Move documentation to inline comments: GtkHScale



commit 62c878b0cd00c73685db8618d75d16d2d0e204bf
Author: Javier Jardón <jjardon gnome org>
Date:   Mon Apr 11 03:04:20 2011 +0100

    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(-)
---
diff --git a/docs/reference/gtk/tmpl/.gitignore b/docs/reference/gtk/tmpl/.gitignore
index 469aa22..69350ee 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/gtk/gtkhscale.c b/gtk/gtkhscale.c
index a8b86e4..84ea86a 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)
 {



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]