[gtk+] Update gtkvscale documentation for in code comments. Removed template document



commit 69279262bc0afdd6a92e4049b24cc80e10889581
Author: Steven Harms <sharms ubuntu com>
Date:   Wed Mar 3 16:39:29 2010 -0500

    Update gtkvscale documentation for in code comments. Removed template document

 docs/reference/gtk/tmpl/gtkvscale.sgml |   51 --------------------------------
 gtk/gtkvscale.c                        |   20 ++++++++++++-
 gtk/gtkvscale.h                        |    6 ++++
 3 files changed, 25 insertions(+), 52 deletions(-)
---
diff --git a/gtk/gtkvscale.c b/gtk/gtkvscale.c
index 20d39bc..a36402b 100644
--- a/gtk/gtkvscale.c
+++ b/gtk/gtkvscale.c
@@ -33,6 +33,17 @@
 #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)
 {
diff --git a/gtk/gtkvscale.h b/gtk/gtkvscale.h
index 8409912..cf67920 100644
--- a/gtk/gtkvscale.h
+++ b/gtk/gtkvscale.h
@@ -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;



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