From 89d7a876fac71260184fead25b58a2220f19a778 Mon Sep 17 00:00:00 2001 From: Lais Andrade Date: Tue, 23 Feb 2021 11:07:31 +0000 Subject: [PATCH] Fix Vibrator and VibratorManager public API docs Add information about value returned by Vibrator.getId, including a description of what the default -1 value represents. Fix description of CombinedVibrationEffect arguments to VibratorManager methods. Fix: 180962151 Fix: 180963421 Test: N/A Change-Id: I3fab2d5fe299be5a951f32bd75eb2e5275ef6e56 --- core/java/android/os/Vibrator.java | 3 ++- 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 d6fa733927fbb..b003d238c2687 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 5dd38b6cbd862..5a01814508e15 100644 --- a/core/java/android/os/VibratorManager.java +++ b/core/java/android/os/VibratorManager.java @@ -91,10 +91,10 @@ public abstract class VibratorManager { * *

* 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. *

* - * @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. *

* - * @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