Explain what the global variables do.
authorMalte S. Stretz <mss@apache.org>
Mon, 9 Mar 2009 14:54:24 +0000 (14:54 +0000)
committerMalte S. Stretz <mss@apache.org>
Mon, 9 Mar 2009 14:54:24 +0000 (14:54 +0000)
src/dmx.c

index 51a5232..934cb2f 100644 (file)
--- a/src/dmx.c
+++ b/src/dmx.c
@@ -7,6 +7,9 @@
 /*********************************************************************/
 /* Declaration of private global variables.                          */
 
+/**
+ * The DMX parser is driven by a state machine using these states.
+ */
 enum state {
   STATE_IDLE,
   STATE_SYNC,
@@ -14,7 +17,13 @@ enum state {
   STATE_RECV,
   STATE_STOR
 };
+/**
+ * The current state of the DMX state machine.
+ */
 static volatile enum state state_;
+/**
+ * Index of current DMX frame (between 0 and 512).
+ */
 static          int16_t index_;