From 3884f0239da9a9d034f4f9633d34acfb25adb194 Mon Sep 17 00:00:00 2001
From: schneider <schneider@blinkenlichts.net>
Date: Fri, 19 Jul 2019 00:12:57 +0200
Subject: [PATCH] doc(api): Add api_interrupt_enable/disable docstring

---
 epicardium/epicardium.h | 14 +++++++++++---
 1 file changed, 11 insertions(+), 3 deletions(-)

diff --git a/epicardium/epicardium.h b/epicardium/epicardium.h
index 4a7cc404c..79e51a5fe 100644
--- a/epicardium/epicardium.h
+++ b/epicardium/epicardium.h
@@ -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 */
-- 
GitLab