Commit 6cdeb370 authored by Steven Harms's avatar Steven Harms Committed by Javier Jardón

[docs] Move documentation to inline comments: GtkVRuler

Fixes https://bugzilla.gnome.org/show_bug.cgi?id=611656Signed-off-by: default avatarJavier Jardón <jjardon@gnome.org>
parent 25b6994c
<!-- ##### SECTION Title ##### -->
GtkVRuler
<!-- ##### SECTION Short_Description ##### -->
A vertical ruler
<!-- ##### SECTION Long_Description ##### -->
<note>
<para>
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.
</para>
</note>
<para>
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.
rulers.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT GtkVRuler ##### -->
<para>
The #GtkVRuler struct contains private data and should be accessed
using the functions below.
</para>
<!-- ##### FUNCTION gtk_vruler_new ##### -->
<para>
Creates a new vertical ruler
</para>
@Returns: a new #GtkVRuler.
......@@ -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)
{
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment