Skip to content
Snippets Groups Projects
Commit 3884f023 authored by schneider's avatar schneider
Browse files

doc(api): Add api_interrupt_enable/disable docstring

parent 04bf54df
No related branches found
No related tags found
No related merge requests found
Pipeline #1311 passed
......@@ -81,15 +81,23 @@ API(API_VIBRA_SET, void epic_vibra_set(int status));
*/
API(API_VIBRA_VIBRATE, void epic_vibra_vibrate(int millis));
/* Type of interrupt IDs */
/**
* API interrupt type
*/
typedef uint32_t api_int_id_t;
/**
* Turn vibration motor on for a given time
* Enable/unmask an API interrupt
*
* :param millis: number of milliseconds to run the vibration motor.
* :param int_id: The interrupt to be enabled
*/
API(API_INTERRUPT_ENABLE, void api_interrupt_enable(api_int_id_t int_id));
/**
* Disable/mask an API interrupt
*
* :param int_id: The interrupt to be disabled
*/
API(API_INTERRUPT_DISABLE, void api_interrupt_disable(api_int_id_t int_id));
#endif /* _EPICARDIUM_H */
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment