Android/frameworks_base
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge "Fix Vibrator and VibratorManager public API docs" into sc-dev

Browse Source
This commit is contained in:
TreeHugger Robot
2021-02-23 19:00:43 +00:00
committed by Android (Google) Code Review
parent 85bde7b023 89d7a876fa
commit 1d55488df5
2 changed files with 5 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
core/java/android/os/Vibrator.java
View File

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

6
core/java/android/os/VibratorManager.java
View File

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