Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit f0b6e435 authored by Yeabkal Wubshit's avatar Yeabkal Wubshit
Browse files

nit: Update VelocityTracker Javadoc 

We have added APIs to query velocity for axes beyond X/Y, so let the
VelocityTracker class' Javadoc reflect this capability.

Bug: 271009383
Test: N/A
Change-Id: I9ba2e40d9ec7e407013d67e9a9953ae8df44ec7e
parent 64549608

core/java/android/view/VelocityTracker.java

+4 −3
Original line number Diff line number Diff line
@@ -32,9 +32,10 @@ import java.util.Map; 
 *

 * Use {@link #obtain} to retrieve a new instance of the class when you are going

 * to begin tracking.  Put the motion events you receive into it with

 * {@link #addMovement(MotionEvent)}.  When you want to determine the velocity call

 * {@link #computeCurrentVelocity(int)} and then call {@link #getXVelocity(int)}

 * and {@link #getYVelocity(int)} to retrieve the velocity for each pointer id.

 * {@link #addMovement(MotionEvent)}.  When you want to determine the velocity, call

 * {@link #computeCurrentVelocity(int)} and then call the velocity-getter methods like

 * {@link #getXVelocity(int)}, {@link #getYVelocity(int)}, or {@link #getAxisVelocity(int, int)}

 * to retrieve velocity for different axes and/or pointer IDs.

 */

public final class VelocityTracker {

    private static final SynchronizedPool<VelocityTracker> sPool =