docs: Specify scroll_to_point() coordinate space
authorEmmanuele Bassi <ebassi@linux.intel.com>
Wed, 25 Apr 2012 16:22:10 +0000 (17:22 +0100)
committerEmmanuele Bassi <ebassi@linux.intel.com>
Fri, 27 Apr 2012 11:30:50 +0000 (12:30 +0100)
clutter/clutter-scroll-actor.c

index 4d78da1..2cb71b1 100644 (file)
@@ -366,6 +366,8 @@ on_transition_completed (ClutterTimeline *timeline,
  * Scrolls the contents of @actor so that @point is the new origin
  * of the visible area.
  *
+ * The coordinates of @point must be relative to the @actor.
+ *
  * This function will use the currently set easing state of the @actor
  * to transition from the current scroll origin to the new one.
  *