a little documentation

1 files changed, 6 insertions, 6 deletions

diff --git a/c/arduino/arq.h b/c/arduino/arq.h
index 592b0d4..c1a44ef 100644
--- a/c/arduino/arq.h
+++ b/c/arduino/arq.h
@@ -12,12 +12,12 @@ extern "C" {
 
 
 typedef enum {
-  RECEIVED = 0,
-  SEND_SUCCESS = 1,
-  NO_ACK = 3,
-  BAD_ACK = 4,
-  SIZE_ERROR = 5,
-  BUSY = 6
+  RECEIVED = 0, //mesage received (received message given in event handler)
+  SEND_SUCCESS = 1, //mesage was successfully sent (message sent given in event handler)
+  NO_ACK = 3, //no ack was received for given message (message sent given in event handler)
+  BAD_ACK = 4, //bad ack or data was received for given message (message sent given in event handler)
+  SIZE_ERROR = 5, //the message being sent is too large (message trying to be sent given in event handler)
+  BUSY = 6 //a message has already been sent and an ack is awaited (message trying to be sent given in event handler)
 } message_event;
 
 typedef void (*send_frame_function)(int16_t size, uint8_t* data);