]> Pileus Git - ~andy/gtk/commitdiff
Update gtkvscale documentation for in code comments. Removed template document
authorSteven Harms <sharms@ubuntu.com>
Wed, 3 Mar 2010 21:39:29 +0000 (16:39 -0500)
committerJavier Jardón <jjardon@gnome.org>
Wed, 3 Mar 2010 22:46:15 +0000 (23:46 +0100)
docs/reference/gtk/tmpl/gtkvscale.sgml [deleted file]
gtk/gtkvscale.c
gtk/gtkvscale.h

diff --git a/docs/reference/gtk/tmpl/gtkvscale.sgml b/docs/reference/gtk/tmpl/gtkvscale.sgml
deleted file mode 100644 (file)
index dcf7b6e..0000000
+++ /dev/null
@@ -1,51 +0,0 @@
-<!-- ##### SECTION Title ##### -->
-GtkVScale
-
-<!-- ##### SECTION Short_Description ##### -->
-A vertical slider widget for selecting a value from a range
-
-<!-- ##### SECTION Long_Description ##### -->
-<para>
-The #GtkVScale widget is used to allow the user to select a value using
-a vertical 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 ##### -->
-
-
-<!-- ##### STRUCT GtkVScale ##### -->
-<para>
-The #GtkVScale-struct struct contains private data only, and
-should be accessed using the functions below.
-</para>
-
-
-<!-- ##### FUNCTION gtk_vscale_new ##### -->
-<para>
-Creates a new #GtkVScale.
-</para>
-
-@adjustment: the #GtkAdjustment which sets the range of the scale.
-@Returns: a new #GtkVScale.
-
-
-<!-- ##### FUNCTION gtk_vscale_new_with_range ##### -->
-<para>
-
-</para>
-
-@min: 
-@max: 
-@step: 
-@Returns: 
-
-
index 20d39bcb3b6c709f00153e736320e4db8f22318a..a36402b6f978a0bbc64d79e39e33fff185d839b3 100644 (file)
 #include "gtkorientable.h"
 #include "gtkalias.h"
 
+/**
+ * SECTION:gtkvscale
+ * @Short_description: A vertical slider widget for selecting a value from a range
+ * @Title: GtkVScale
+ *
+ * The #GtkVScale widget is used to allow the user to select a value using
+ * a vertical 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 (GtkVScale, gtk_vscale, GTK_TYPE_SCALE)
 
@@ -50,7 +61,14 @@ gtk_vscale_init (GtkVScale *vscale)
   gtk_orientable_set_orientation (GTK_ORIENTABLE (vscale),
                                   GTK_ORIENTATION_VERTICAL);
 }
-
+/**
+ * gtk_vscale_new:
+ * @adjustment: the #GtkAdjustment which sets the range of the scale.
+ *
+ * Creates a new #GtkVScale.
+ *
+ * Returns: a new #GtkVScale.
+ */
 GtkWidget *
 gtk_vscale_new (GtkAdjustment *adjustment)
 {
index 8409912fa8e5c1eb47cddee74445869a66efb51e..cf67920596f070c85c579045afb32b446df3031a 100644 (file)
@@ -49,6 +49,12 @@ G_BEGIN_DECLS
 typedef struct _GtkVScale       GtkVScale;
 typedef struct _GtkVScaleClass  GtkVScaleClass;
 
+/**
+ * GtkVScale:
+ *
+ * The #GtkVScale struct contains private data only, and
+ * should be accessed using the functions below.
+ */
 struct _GtkVScale
 {
   GtkScale scale;