[gtk+] [docs] Move documentation to inline comments: GtkVRuler

[Javier Jardón <jjardon src gnome org>]

commit 6cdeb370a11b81ded06203bd5af12e8207830f46
Author: Steven Harms <sharms ubuntu com>
Date:   Wed Mar 3 19:11:46 2010 -0500

    [docs] Move documentation to inline comments: GtkVRuler
    
    Fixes https://bugzilla.gnome.org/show_bug.cgi?id=611656
    
    Signed-off-by: Javier Jardón <jjardon gnome org>

 docs/reference/gtk/tmpl/gtkvruler.sgml |   50 --------------------------------
 gtk/gtkvruler.c                        |   29 ++++++++++++++++++
 2 files changed, 29 insertions(+), 50 deletions(-)
---
diff --git a/gtk/gtkvruler.c b/gtk/gtkvruler.c
index 7dc104b..5bff897 100644
--- a/gtk/gtkvruler.c
+++ b/gtk/gtkvruler.c
@@ -30,6 +30,28 @@
 #include "gtkvruler.h"
 #include "gtkalias.h"
 
+/**
+ * SECTION:gtkvruler
+ * @Short_description: A vertical ruler
+ * @Title: GtkVRuler
+ *
+ * <note>
+ *  This widget is considered too specialized/little-used for
+ *  GTK+, and will in the future be moved to some other package.  If
+ *  your application needs this widget, feel free to use it, as the
+ *  widget does work and is useful in some applications; it's just not
+ *  of general interest. However, we are not accepting new features for
+ *  the widget, and it will eventually move out of the GTK+
+ *  distribution.
+ * </note>
+ *
+ * The VRuler widget is a widget arranged vertically creating a ruler that is
+ * utilized around other widgets such as a text widget. The ruler is used to show
+ * the location of the mouse on the window and to show the size of the window in
+ * specified units. The available units of measurement are GTK_PIXELS, GTK_INCHES
+ * and GTK_CENTIMETERS. GTK_PIXELS is the default unit of measurement.
+ */
+
 G_DEFINE_TYPE (GtkVRuler, gtk_vruler, GTK_TYPE_RULER)
 
 static void
@@ -44,6 +66,13 @@ gtk_vruler_init (GtkVRuler *vruler)
                                   GTK_ORIENTATION_VERTICAL);
 }
 
+/**
+ * gtk_vruler_new:
+ *
+ * Creates a new vertical ruler
+ *
+ * Returns: a new #GtkVRuler.
+ */
 GtkWidget *
 gtk_vruler_new (void)
 {