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

Commit 4f6f5291 authored by Yeabkal Wubshit's avatar Yeabkal Wubshit
Browse files

Improve ScrollFeedbackProvider API Javadoc 

Reworded the summary statement to clarify that the feedback is feedback
given to the user, and that it may depend on the configuration of the
InputDevice that generated the scroll event. Also added a small
paragraph to give an example of feedback that may be provided by this
interface.

Bug: 260290361
Test: n/a
Change-Id: I8e21fbff8f87384581df1722ba4ba919b5395486
parent 4c38c543

core/java/android/view/ScrollFeedbackProvider.java

+5 −2
Original line number Diff line number Diff line
@@ -21,8 +21,11 @@ import android.annotation.NonNull; 
import android.view.flags.Flags;



/**

 * Interface to represent an entity giving consistent feedback for different events surrounding view

 * scroll.

 * Provides feedback to the user for scroll events on a {@link View}. The type of feedback provided

 * to the user may depend on the {@link InputDevice} that generated the scroll events.

 *

 * <p>An example of the type of feedback that this interface may provide is haptic feedback (that

 * is, tactile feedback that provide the user physical feedback for their scroll).

 *

 * <p>The interface provides methods for the client to report different scroll events. The client

 * should report all scroll events that they want to be considered for scroll feedback using the