[gtk+] gtkscrollbar: Move documentation to inline comments



commit 96f2f2ff5bdeb2520de5c1e10919b1e203e8921e
Author: Javier Jardón <jjardon gnome org>
Date:   Fri Oct 22 22:41:55 2010 +0200

    gtkscrollbar: Move documentation to inline comments

 docs/reference/gtk/tmpl/.gitignore        |    1 +
 docs/reference/gtk/tmpl/gtkscrollbar.sgml |  103 -----------------------------
 gtk/gtkscrollbar.c                        |   25 +++++++
 3 files changed, 26 insertions(+), 103 deletions(-)
---
diff --git a/docs/reference/gtk/tmpl/.gitignore b/docs/reference/gtk/tmpl/.gitignore
index b1a29e6..1f16d5c 100644
--- a/docs/reference/gtk/tmpl/.gitignore
+++ b/docs/reference/gtk/tmpl/.gitignore
@@ -36,6 +36,7 @@ gtkrecentchooserwidget.sgml
 gtkrecentmanager.sgml
 gtkscale.sgml
 gtkscalebutton.sgml
+gtkscrollbar.sgml
 gtkscrolledwindow.sgml
 gtkseparator.sgml
 gtkseparatormenuitem.sgml
diff --git a/gtk/gtkscrollbar.c b/gtk/gtkscrollbar.c
index ce41a23..d04ed7c 100644
--- a/gtk/gtkscrollbar.c
+++ b/gtk/gtkscrollbar.c
@@ -31,6 +31,31 @@
 #include "gtkintl.h"
 #include "gtkprivate.h"
 
+
+/**
+ * SECTION:gtkscrollbar
+ * @Short_description: Base class for GtkHScrollbar and GtkVScrollbar
+ * @Title: GtkScrollbar
+ * @See_also: #GtkHScrollbar, #GtkVScrollbar, #GtkAdjustment,
+ *   #GtkScrolledWindow
+ *
+ * The #GtkScrollbar widget is the base class for #GtkHScrollbar and
+ * #GtkVScrollbar. It can be used in the same way as these, by setting
+ * the "orientation" property appropriately.
+ *
+ * The position of the thumb in a scrollbar is controlled by the scroll
+ * adjustments. See #GtkAdjustment for the fields in an adjustment - for
+ * #GtkScrollbar, the #GtkAdjustment.value field represents the position
+ * of the scrollbar, which must be between the #GtkAdjustment.lower field
+ * and #GtkAdjustment.upper - #GtkAdjustment.page_size. The
+ * #GtkAdjustment.page_size field represents the size of the visible
+ * scrollable area. The #GtkAdjustment.step_increment and
+ * #GtkAdjustment.page_increment fields are used when the user asks to
+ * step down (using the small stepper arrows) or page down (using for
+ * example the <keycap>PageDown</keycap> key).
+ */
+
+
 static void gtk_scrollbar_style_set (GtkWidget *widget,
                                      GtkStyle  *previous);
 



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