Diff: LEDDriver.h

Revision:

8:a987e04734dd

Parent:

6:36158325f7b0

Child:

9:c800045806f0

--- a/LEDDriver.h	Sun Apr 15 10:02:17 2018 +0000
+++ b/LEDDriver.h	Sun Apr 15 19:37:01 2018 +0000
@@ -8,6 +8,7 @@
 class LEDDriver
 {
     private:
+    
     int** messageList;
     int* start;
     int* stop;
@@ -16,14 +17,45 @@
     Copy copy;
     DigitalOut* leds;
     
+  /**
+    *method that returns the direction stored in the private direction array
+    *@params the id of the led that you want the direction of
+    *@return the direction for the specified led
+    */  
     int getDirection(int id);
+    
+  /**
+    *method that encodes the direction to the message for the specified led
+    *@params the direction to encode into the message
+    *@params the led you want to encode the message for
+    */  
     void encode(int direction,int led);
+   
+  /**
+    *method that encodes the messages for the specified number of leds
+    *@params the number of leds to encode the message for
+    */  
     void encodeAll(int numberOfLeds);
     
     public:
     
+  /**
+    *method to drive the leds
+    *@params the number of leds
+    */  
     void drive(int numberOfLeds);
+    
+  /**
+    *method that copies the array for the specified records in another array
+    *@params the array that has the shared array with directions
+    *@params the number of directions
+    */  
     LEDDriver(/*Mutex* lock,*/ int sharedDirections[], int sizeOfSharedDirections);
+    
+    /**
+    *method that is prepared to run
+    *@params the number of leds to run
+    */  
     void run(int numberOfLeds);
 
 };