Merge branch 'master' into 'master'

Refine *_scroll_to_point documentation

Closes #12

See merge request GNOME/atk!21

4 files changed, 13 insertions, 6 deletions

diff --git a/atk/atkcomponent.c b/atk/atkcomponent.c
index 080d521..3949116 100644
--- a/atk/atkcomponent.c
+++ b/atk/atkcomponent.c
@@ -623,8 +623,8 @@ atk_component_scroll_to (AtkComponent  *component,
  * @x: x-position where to scroll to
  * @y: y-position where to scroll to
  *
- * Makes an object visible on the screen at a given position by scrolling all
- * necessary parents.
+ * Move the top-left of @component to a given position of the screen by
+ * scrolling all necessary parents.
  *
  * Returns: whether scrolling was successful.
  *
diff --git a/atk/atkcomponent.h b/atk/atkcomponent.h
index 72e9f7d..e764be7 100644
--- a/atk/atkcomponent.h
+++ b/atk/atkcomponent.h
@@ -203,6 +203,13 @@ struct _AtkComponentIface
 
   /*
    * Scrolls this object so it becomes visible on the screen.
+   *
+   * scroll_to lets the implementation compute an appropriate target
+   * position on the screen, with type used as a positioning hint.
+   *
+   * scroll_to_point lets the client specify a precise target position
+   * on the screen for the top-left of the object.
+   *
    * Since ATK 2.30
    */
   gboolean                (*scroll_to)          (AtkComponent   *component,
diff --git a/atk/atktext.c b/atk/atktext.c
index fec90b0..c15ea78 100644
--- a/atk/atktext.c
+++ b/atk/atktext.c
@@ -1378,7 +1378,7 @@ atk_text_rectangle_contain (AtkTextRectangle *clip,
  * @end_offset: end position, or -1 for the end of the string.
  * @type: specify where the object should be made visible.
  *
- * Makes @text visible on the screen by scrolling all necessary parents.
+ * 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
@@ -1415,8 +1415,8 @@ atk_text_scroll_substring_to (AtkText       *text,
  * @x: x-position where to scroll to
  * @y: y-position where to scroll to
  *
- * Makes an object visible on the screen at a given position by scrolling all
- * necessary parents.
+ * Move the top-left of a substring of @text to a given position of the screen
+ * by scrolling all necessary parents.
  *
  * Since: 2.32
  *
diff --git a/atk/atktext.h b/atk/atktext.h
index 32f0bf2..ca66a43 100644
--- a/atk/atktext.h
+++ b/atk/atktext.h
@@ -341,7 +341,7 @@ struct _AtkTextIface
    * position on the screen, with type used as a positioning hint.
    *
    * scroll_substring_to_point lets the client specify a precise target position
-   * on the screen.
+   * on the screen for the top-left of the substring.
    *
    * Since ATK 2.32
    */