[gtk+] gtkscale: move documentation to inline comments



commit 6e5d65c9af7627e5d5925004edfc67c9a5bf3da9
Author: Javier Jardón <jjardon gnome org>
Date:   Wed Sep 1 20:18:22 2010 +0200

    gtkscale: move documentation to inline comments

 docs/reference/gtk/tmpl/.gitignore    |    1 +
 docs/reference/gtk/tmpl/gtkscale.sgml |  193 ---------------------------------
 gtk/gtkscale.c                        |   24 ++++
 3 files changed, 25 insertions(+), 193 deletions(-)
---
diff --git a/docs/reference/gtk/tmpl/.gitignore b/docs/reference/gtk/tmpl/.gitignore
index ad67ef7..f0d29d1 100644
--- a/docs/reference/gtk/tmpl/.gitignore
+++ b/docs/reference/gtk/tmpl/.gitignore
@@ -23,6 +23,7 @@ gtkrecentchooserdialog.sgml
 gtkrecentchoosermenu.sgml
 gtkrecentchooserwidget.sgml
 gtkrecentmanager.sgml
+gtkscale.sgml
 gtkscalebutton.sgml
 gtkseparator.sgml
 gtkseparatormenuitem.sgml
diff --git a/gtk/gtkscale.c b/gtk/gtkscale.c
index e03013d..853b1cf 100644
--- a/gtk/gtkscale.c
+++ b/gtk/gtkscale.c
@@ -42,6 +42,30 @@
 #include "gtkbuildable.h"
 #include "gtkbuilderprivate.h"
 
+
+/**
+ * SECTION:gtkscale
+ * @Short_description: Base class for #GtkHScale and #GtkVScale
+ * @Title: GtkScale
+ *
+ * A #GtkScale is a slider control used to select a numeric value.
+ * To use it, you'll probably want to investigate the methods on
+ * its base class, #GtkRange, in addition to the methods for #GtkScale itself.
+ * To set the value of a scale, you would normally use gtk_range_set_value().
+ * To detect changes to the value, you would normally use the
+ * #GtkRange::value_changed signal.
+ *
+ * <refsect2 id="GtkScale-BUILDER-UI"><title>GtkScale as GtkBuildable</title>
+ * GtkScale supports a custom &lt;marks&gt; element, which
+ * can contain multiple &lt;mark&gt; elements. The "value" and "position"
+ * attributes have the same meaning as gtk_scale_add_mark() parameters of the
+ * same name. If the element is not empty, its content is taken as the markup
+ * to show at the mark. It can be translated with the usual "translatable and
+ * "context" attributes.
+ * </refsect2>
+ */
+
+
 #define	MAX_DIGITS	(64)	/* don't change this,
 				 * a) you don't need to and
 				 * b) you might cause buffer owerflows in



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