summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSamuel Thibault <samuel.thibault@ens-lyon.org>2019-08-28 16:21:36 +0200
committerSamuel Thibault <samuel.thibault@ens-lyon.org>2019-08-28 16:21:41 +0200
commitb9fa8466dadcc1ee62ed1a498168770447fc78d3 (patch)
treea4bf7ebcb9b706ad49d63a4cb097461a174fd72e
parentd27c3e373eb136e57f31ec0c90ae7fc413ff8a66 (diff)
downloadatk-b9fa8466dadcc1ee62ed1a498168770447fc78d3.tar.gz
Refine AtkScrollType documentation
To better specify the behavior for e.g. top-left vs bottom-right. Fixes #12
-rw-r--r--atk/atkcomponent.h24
1 files changed, 12 insertions, 12 deletions
diff --git a/atk/atkcomponent.h b/atk/atkcomponent.h
index e764be7..ae66772 100644
--- a/atk/atkcomponent.h
+++ b/atk/atkcomponent.h
@@ -31,18 +31,18 @@ G_BEGIN_DECLS
/**
* AtkScrollType:
- * @ATK_SCROLL_TOP_LEFT: Scroll the object vertically and horizontally to the top
- * left corner of the window.
- * @ATK_SCROLL_BOTTOM_RIGHT: Scroll the object vertically and horizontally to the
- * bottom right corner of the window.
- * @ATK_SCROLL_TOP_EDGE: Scroll the object vertically to the top edge of the
- * window.
- * @ATK_SCROLL_BOTTOM_EDGE: Scroll the object vertically to the bottom edge of
- * the window.
- * @ATK_SCROLL_LEFT_EDGE: Scroll the object vertically and horizontally to the
- * left edge of the window.
- * @ATK_SCROLL_RIGHT_EDGE: Scroll the object vertically and horizontally to the
- * right edge of the window.
+ * @ATK_SCROLL_TOP_LEFT: Scroll the object vertically and horizontally to bring
+ * its top left corner to the top left corner of the window.
+ * @ATK_SCROLL_BOTTOM_RIGHT: Scroll the object vertically and horizontally to
+ * bring its bottom right corner to the bottom right corner of the window.
+ * @ATK_SCROLL_TOP_EDGE: Scroll the object vertically to bring its top edge to
+ * the top edge of the window.
+ * @ATK_SCROLL_BOTTOM_EDGE: Scroll the object vertically to bring its bottom
+ * edge to the bottom edge of the window.
+ * @ATK_SCROLL_LEFT_EDGE: Scroll the object vertically and horizontally to bring
+ * its left edge to the left edge of the window.
+ * @ATK_SCROLL_RIGHT_EDGE: Scroll the object vertically and horizontally to
+ * bring its right edge to the right edge of the window.
* @ATK_SCROLL_ANYWHERE: Scroll the object vertically and horizontally so that
* as much as possible of the object becomes visible. The exact placement is
* determined by the application.