St: annotate st_adjustment_get_values()

2011-02-16 16:06:31 -05:00 · 2011-02-16 16:06:31 -05:00 · bb70be31c0
commit bb70be31c0
parent 6b429b7f50
1 changed files with 12 additions and 0 deletions
--- a/src/st/st-adjustment.c
+++ b/src/st/st-adjustment.c
@ -602,6 +602,18 @@ st_adjustment_set_values (StAdjustment *adjustment,
  g_object_thaw_notify (G_OBJECT (adjustment));
 }

+/**
+ * st_adjustment_get_values:
+ * @adjustment: an #StAdjustment
+ * @value: (out): the current value
+ * @lower: (out): the lower bound
+ * @upper: (out): the upper bound
+ * @step_increment: (out): the step increment
+ * @page_increment: (out): the page increment
+ * @page_size: (out): the page size
+ *
+ * Gets all of @adjustment's values at once.
+ */
 void
 st_adjustment_get_values (StAdjustment *adjustment,
                          gdouble      *value,