doc: Clarify that the timeout is in seconds

This commit is contained in:
Evangelos Ribeiro Tzaras
2021-10-29 18:00:02 +02:00
parent 5f28638eec
commit b2a8061cdc
2 changed files with 2 additions and 2 deletions
+1 -1
View File
@@ -21,7 +21,7 @@
@app_id: The application id usually in "reverse DNS" format
@event: The event name from the Event naming spec
@hints: Additional hints (e.g. to prefer haptic feedback over audio feedback on button press events, currently unused)
@timeout: When the feedbacks for this event should end latest. The special values '-1' (just run each feedback once) and '0' (endless loop) are also supported.
@timeout: When the feedbacks for this event should end latest in seconds. The special values '-1' (just run each feedback once) and '0' (endless loop) are also supported.
@id: Event id for future reference
Give user feedback for an event by triggering feedbacks
+1 -1
View File
@@ -294,7 +294,7 @@ lfb_event_class_init (LfbEventClass *klass)
/**
* LfbEvent:timeout:
*
* How long feedback should be provided in milliseconds. The special value
* How long feedback should be provided in seconds. The special value
* %-1 uses the natural length of each feedback while %0 plays each feedback
* in a loop until ended explicitly via e.g. #lfb_event_end_feedback().
*/