diff options
| author | Colin Cross <ccross@android.com> | 2015-11-17 19:31:22 +0000 |
|---|---|---|
| committer | Gerrit Code Review <noreply-gerritcodereview@google.com> | 2015-11-17 19:31:22 +0000 |
| commit | 8447aed33271c3f53849923327d6cfa3f4999e09 (patch) | |
| tree | 134916ed6123df5529abcc156187e11f284badaf | |
| parent | 87dd60511708ce125efce3566a599518779d561b (diff) | |
| parent | 8e09d12f80659bf0d4008832a9190309e16090bb (diff) | |
| download | libhardware-8447aed33271c3f53849923327d6cfa3f4999e09.tar.gz | |
Merge "Vibrator: clarify the API"
| -rw-r--r-- | include/hardware/vibrator.h | 7 |
1 files changed, 3 insertions, 4 deletions
diff --git a/include/hardware/vibrator.h b/include/hardware/vibrator.h index 92b1fd00..200adf09 100644 --- a/include/hardware/vibrator.h +++ b/include/hardware/vibrator.h @@ -45,8 +45,8 @@ typedef struct vibrator_device { /** Turn on vibrator * - * What happens when this function is called while the the timeout of a - * previous call has not expired is implementation dependent. + * This function must only be called after the previous timeout has expired or + * was canceled (through vibrator_off()). * * @param timeout_ms number of milliseconds to vibrate * @@ -56,8 +56,7 @@ typedef struct vibrator_device { /** Turn off vibrator * - * It is not guaranteed that the vibrator will be immediately stopped: the - * behaviour is implementation dependent. + * Cancel a previously-started vibration, if any. * * @return 0 in case of success, negative errno code else */ |