diff options
author | Javier Jardón <jjardon@gnome.org> | 2010-10-23 00:16:27 +0200 |
---|---|---|
committer | Javier Jardón <jjardon@gnome.org> | 2010-10-23 00:31:37 +0200 |
commit | 38dbb84095dee0fa9f4688e15ebd33591a9a6548 (patch) | |
tree | 79df5690f1559e5ad45bfb435f1934c6e7656707 /gtk/gtkadjustment.h | |
parent | 96f2f2ff5bdeb2520de5c1e10919b1e203e8921e (diff) | |
download | gtk+-38dbb84095dee0fa9f4688e15ebd33591a9a6548.tar.gz |
gtkadjustment: Move documentation to inline comments
Diffstat (limited to 'gtk/gtkadjustment.h')
-rw-r--r-- | gtk/gtkadjustment.h | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/gtk/gtkadjustment.h b/gtk/gtkadjustment.h index 7cac64292c..319953b342 100644 --- a/gtk/gtkadjustment.h +++ b/gtk/gtkadjustment.h @@ -46,6 +46,22 @@ G_BEGIN_DECLS typedef struct _GtkAdjustment GtkAdjustment; typedef struct _GtkAdjustmentClass GtkAdjustmentClass; +/** + * GtkAdjustment: + * @lower: the minimum value. + * @upper: the maximum value. + * @value: the current value. + * @step_increment: the increment to use to make minor changes to the @value. + * In a #GtkScrollbar this increment is used when the mouse is clicked on the + * arrows at the top and bottom of the scrollbar, to scroll by a small amount. + * @page_increment: the increment to use to make major changes to the @value. + * In a #GtkScrollbar this increment is used when the mouse is clicked in the + * trough, to scroll by a large amount. + * @page_size: In a #GtkScrollbar this is the size of the area which is currently + * visible. + * + * The #GtkAdjustment struct contains the following fields. + */ struct _GtkAdjustment { GInitiallyUnowned parent_instance; |