diff options
| author | TreeHugger Robot <treehugger-gerrit@google.com> | 2021-02-23 19:00:43 +0000 |
|---|---|---|
| committer | Android (Google) Code Review <android-gerrit@google.com> | 2021-02-23 19:00:43 +0000 |
| commit | 1d55488df57eda0c021c342d8410bd5d898abe95 (patch) | |
| tree | 7aa229e626f64d1d0d0fb7babdaa5a0198432dee /core/java/android | |
| parent | 85bde7b023342127bdd85a8eadcb7df0d83221c4 (diff) | |
| parent | 89d7a876fac71260184fead25b58a2220f19a778 (diff) | |
Merge "Fix Vibrator and VibratorManager public API docs" into sc-dev
Diffstat (limited to 'core/java/android')
| -rw-r--r-- | core/java/android/os/Vibrator.java | 3 | ||||
| -rw-r--r-- | core/java/android/os/VibratorManager.java | 6 |
2 files changed, 5 insertions, 4 deletions
diff --git a/core/java/android/os/Vibrator.java b/core/java/android/os/Vibrator.java index d6fa733927fb..b003d238c268 100644 --- a/core/java/android/os/Vibrator.java +++ b/core/java/android/os/Vibrator.java @@ -186,7 +186,8 @@ public abstract class Vibrator { /** * Return the ID of this vibrator. * - * @return The id of the vibrator controlled by this service. + * @return A non-negative integer representing the id of the vibrator controlled by this + * service, or -1 this service is not attached to any physical vibrator. */ public int getId() { return -1; diff --git a/core/java/android/os/VibratorManager.java b/core/java/android/os/VibratorManager.java index 5dd38b6cbd86..5a01814508e1 100644 --- a/core/java/android/os/VibratorManager.java +++ b/core/java/android/os/VibratorManager.java @@ -91,10 +91,10 @@ public abstract class VibratorManager { * * <p> * Pass in a {@link CombinedVibrationEffect} representing a combination of {@link - * VibrationEffect} to be played on one or more vibrators. + * VibrationEffect VibrationEffects} to be played on one or more vibrators. * </p> * - * @param effect an array of longs of times for which to turn the vibrator on or off. + * @param effect a combination of effects to be performed by one or more vibrators. */ @RequiresPermission(android.Manifest.permission.VIBRATE) public final void vibrate(@NonNull CombinedVibrationEffect effect) { @@ -109,7 +109,7 @@ public abstract class VibratorManager { * VibrationEffect} to be played on one or more vibrators. * </p> * - * @param effect an array of longs of times for which to turn the vibrator on or off. + * @param effect a combination of effects to be performed by one or more vibrators. * @param attributes {@link VibrationAttributes} corresponding to the vibration. For example, * specify {@link VibrationAttributes#USAGE_ALARM} for alarm vibrations or * {@link VibrationAttributes#USAGE_RINGTONE} for vibrations associated with |