diff options
author | Steven Harms <sharms@ubuntu.com> | 2010-03-03 19:11:46 -0500 |
---|---|---|
committer | Javier Jardón <jjardon@gnome.org> | 2010-04-18 03:55:22 +0200 |
commit | 6cdeb370a11b81ded06203bd5af12e8207830f46 (patch) | |
tree | 1e0abdb28ed68e6f54ee53cee72411e7a56b83da | |
parent | 25b6994cbabea88b64f047e0b645054d23c96c9a (diff) | |
download | gdk-pixbuf-6cdeb370a11b81ded06203bd5af12e8207830f46.tar.gz |
[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>
-rw-r--r-- | docs/reference/gtk/tmpl/gtkvruler.sgml | 50 | ||||
-rw-r--r-- | gtk/gtkvruler.c | 29 |
2 files changed, 29 insertions, 50 deletions
diff --git a/docs/reference/gtk/tmpl/gtkvruler.sgml b/docs/reference/gtk/tmpl/gtkvruler.sgml deleted file mode 100644 index 89b8af90f..000000000 --- a/docs/reference/gtk/tmpl/gtkvruler.sgml +++ /dev/null @@ -1,50 +0,0 @@ -<!-- ##### 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. - - diff --git a/gtk/gtkvruler.c b/gtk/gtkvruler.c index 7dc104b1a..5bff897ab 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) { |