gtkscrollbar: Move documentation to inline comments

1 files changed, 25 insertions, 0 deletions

diff --git a/gtk/gtkscrollbar.c b/gtk/gtkscrollbar.c
index ce41a231bd..d04ed7c387 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);