summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
author Kevin Hufnagle <khufnagle@google.com> 2019-08-29 04:29:08 +0000
committer Kevin Hufnagle <khufnagle@google.com> 2019-08-29 19:30:42 +0000
commit86b17d252322fee376ac53fc8e4be82dea49472b (patch)
treeadd2831a6a5af37d206e2603181a076090b97e34
parentb14d2dede2839b470bcdebdc5d2632fb5dabffa6 (diff)
docs: Improved tick/click effect descriptions
Test: make ds-docs -j32 Bug: 139888074 Change-Id: I939aaa4cf81ddab1705611222c12a60823493d38
-rw-r--r--core/java/android/os/VibrationEffect.java6
1 files changed, 3 insertions, 3 deletions
diff --git a/core/java/android/os/VibrationEffect.java b/core/java/android/os/VibrationEffect.java
index 702b41beb071..26da0a0aee07 100644
--- a/core/java/android/os/VibrationEffect.java
+++ b/core/java/android/os/VibrationEffect.java
@@ -53,7 +53,7 @@ public abstract class VibrationEffect implements Parcelable {
public static final int MAX_AMPLITUDE = 255;
/**
- * A click effect.
+ * A click effect. Use this effect as a baseline, as it's the most common type of click effect.
*
* @see #get(int)
*/
@@ -67,7 +67,7 @@ public abstract class VibrationEffect implements Parcelable {
public static final int EFFECT_DOUBLE_CLICK = Effect.DOUBLE_CLICK;
/**
- * A tick effect.
+ * A tick effect. This effect is less strong compared to {@link #EFFECT_CLICK}.
* @see #get(int)
*/
public static final int EFFECT_TICK = Effect.TICK;
@@ -89,7 +89,7 @@ public abstract class VibrationEffect implements Parcelable {
public static final int EFFECT_POP = Effect.POP;
/**
- * A heavy click effect.
+ * A heavy click effect. This effect is stronger than {@link #EFFECT_CLICK}.
* @see #get(int)
*/
public static final int EFFECT_HEAVY_CLICK = Effect.HEAVY_CLICK;