summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSamuel Thibault <samuel.thibault@ens-lyon.org>2019-09-10 10:45:43 +0000
committerSamuel Thibault <samuel.thibault@ens-lyon.org>2019-09-10 10:45:43 +0000
commit7a4b744208274195dcb48a27b3464a338d1070cd (patch)
tree16bc63a5c8f5afbeeb69bbe9b29935ebe90e5b6e
parentea9664152088f7eeeab258703fdcf820b7ee4fba (diff)
parentb9fa8466dadcc1ee62ed1a498168770447fc78d3 (diff)
downloadatk-7a4b744208274195dcb48a27b3464a338d1070cd.tar.gz
Merge branch 'doc' into 'master'
More scroll doc fixes Closes #12 See merge request GNOME/atk!29
-rw-r--r--atk/atkcomponent.h24
-rw-r--r--atk/atktext.c12
2 files changed, 16 insertions, 20 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.
diff --git a/atk/atktext.c b/atk/atktext.c
index 52d7da1..b85d93f 100644
--- a/atk/atktext.c
+++ b/atk/atktext.c
@@ -1391,16 +1391,12 @@ atk_text_rectangle_contain (AtkTextRectangle *clip,
/**
* atk_text_scroll_substring_to:
* @text: an #AtkText
- * @start_offset: start position
- * @end_offset: end position, or -1 for the end of the string.
+ * @start_offset: start offset in the @text
+ * @end_offset: end offset in the @text, or -1 for the end of the text.
* @type: specify where the object should be made visible.
*
* Makes a substring of @text visible on the screen by scrolling all necessary parents.
*
- * Contrary to atk_text_set_position, this does not actually move
- * @text in its parent, this only makes the parents scroll so that the
- * object shows up on the screen, given its current position within the parents.
- *
* Since: 2.32
*
* Returns: whether scrolling was successful.
@@ -1425,8 +1421,8 @@ atk_text_scroll_substring_to (AtkText *text,
/**
* atk_text_scroll_substring_to_point:
* @text: an #AtkText
- * @start_offset: start position
- * @end_offset: end position, or -1 for the end of the string.
+ * @start_offset: start offset in the @text
+ * @end_offset: end offset in the @text, or -1 for the end of the text.
* @coords: specify whether coordinates are relative to the screen or to the
* parent object.
* @x: x-position where to scroll to