Improve documentation on Vibrator.vibrate. (d10bfe18) · Commits · e / os / android_frameworks_base

core/java/android/os/Vibrator.java

+12 −6

Original line number	Diff line number	Diff line
		@@ -22,6 +22,7 @@ import android.util.Log;
		* Class that operates the vibrator on the device.
		* <p>
		* If your process exits, any vibration you started with will stop.
		* </p>
		*/
		public class Vibrator
		{
		@@ -56,7 +57,7 @@ public class Vibrator
		/**
		* Turn the vibrator on.
		*
		* @param milliseconds How long to vibrate for.
		* @param milliseconds The number of milliseconds to vibrate.
		*/
		public void vibrate(long milliseconds)
		{
		@@ -75,12 +76,17 @@ public class Vibrator
		* Vibrate with a given pattern.
		*
		* <p>
		* Pass in an array of ints that are the times at which to turn on or off
		* the vibrator. The first one is how long to wait before turning it on,
		* and then after that it alternates. If you want to repeat, pass the
		* index into the pattern at which to start the repeat.
		* Pass in an array of ints that are the durations for which to turn on or off
		* the vibrator in milliseconds. The first value indicates the number of milliseconds
		* to wait before turning the vibrator on. The next value indicates the number of milliseconds
		* for which to keep the vibrator on before turning it off. Subsequent values alternate
		* between durations in milliseconds to turn the vibrator off or to turn the vibrator on.
		* </p><p>
		* To cause the pattern to repeat, pass the index into the pattern array at which
		* to start the repeat, or -1 to disable repeating.
		* </p>
		*
		* @param pattern an array of longs of times to turn the vibrator on or off.
		* @param pattern an array of longs of times for which to turn the vibrator on or off.
		* @param repeat the index into pattern at which to repeat, or -1 if
		* you don't want to repeat.
		*/