Diff: Interpreter.cpp

Revision:

35:efdbfccf2678

Parent:

30:915f6cb7ffa5

--- a/Interpreter.cpp	Wed Apr 25 14:51:18 2018 +0000
+++ b/Interpreter.cpp	Wed May 02 06:53:40 2018 +0000
@@ -1,11 +1,22 @@
 #include "Interpreter.h"
 
-
-
+/**
+* @param queue. A pointer to the queue where the commands will be written.
+*/
 Interpreter::Interpreter(Queue<int,8>* queue){
     Interpreter::queue=queue;
 }
 
+/**
+* Interprets a text command, and push the result on the queue.
+* Syntax:
+* The number of the LED
+* Dash (-)
+* The orientation (left,right,up,down or ignore).
+* Multiple LEDS can be set up in one command, by using a whitespace.
+* Example: 0-left 1-right 2-up
+* @param command A character array representing the command.
+*/
 void Interpreter::executeCommand(char* command){
     for(int i=0;i<8;i++){
         LED[i]=-1;
@@ -34,6 +45,11 @@
     }
 }
 
+/**
+* Convert a direction such as left, right, up, down to the corresponding number (0, 1, 2 or 3).
+* Invalid directions (or ignore) will return -1.
+* @param command A character array representing the direction.
+*/
 int Interpreter::directionToNumber(char* direction){
     if(strcmp(direction,"left")==0)
         return 0;