Added some bunch of documentation

Author: Sebastiano Merlino

ael.l

@@ -9,7 +9,7 @@ char *p;
 extern int yywrap(void);
 %}
 
-COMMENT \/\/[^\n]*
+COMMENT \/\/[^\n]*$
 WORD [-a-zA-Z0-9"_/.\<\>\*\+!$#\[\]][-a-zA-Z0-9"_/.!\*\+\<\>\{\}$#\[\]]*
 COLLECTED_WORD (\".*\")|(\$\[[^\]]*\])
 VARNAME $\{[-a-zA-Z][-a-zA-Z0-9]*\}

ael.y

@@ -138,7 +138,6 @@ extern "C"
 %token LOGNOT
 %token LIKEOP
 %token CONDQUEST
-%token COMMENT
 
 %token END 0 "end of file"
 
@@ -163,7 +162,6 @@ object:
     |   macro { $$ = $1; } 
     |   globals { $$ = $1; }
     |   SEMICOLON { $$ = alloc_string((char*)";"); }
-    |   COMMENT { ;};
     ;
 
 context:  

common.h

@@ -1,21 +1,69 @@
 #ifndef _COMMON_H_
 #define _COMMON_H_
 
+/**
+ * Method used to dynamically allocate a string.
+ * @param d The string to allocate
+ * @return the new pointer for the string
+**/
 char* calloc_string(char* d);
 
+/**
+ * Method used to destroy a dinamically allocated string previously archived
+ * @param p The string to delete
+**/
 void destroy_string(char* p);
 
+/**
+ * Method used to clean the archive containing all strings dinamically allocated
+**/
 void recycle_garbage();
 
+/**
+ * Method used to dinamically allocate a string and store it inside temporary archive
+ * @param d The string to allocate
+ * @return a char pointer to the beginning od the newly allocated string
+**/
 char* alloc_string(char* d);
 
+/**
+ * Method used to concatenate two strings
+ * @param head The beginning sting
+ * @param tail The end string
+ * @return a char pointer to the beginning od the newly allocated string
+**/
 char* grow_string(char* head, char* tail);
 
+/**
+ * Method used to extract the variable's name from the variable in string passed
+ * @param c The string containing the variable
+ * @return the variable's name extracted
+**/
 char* extract_variable(char* s);
 
+/**
+ * Method used to extract a binary expression from components
+ * @param a The left size of the expression
+ * @param b The symbol
+ * @param c The right part of the expression
+ * @return The newly created exception
+**/
 char* extract_binary_expr(char* a, char* b, char* c);
 
+/**
+ * Method used to extract a unary expression from components
+ * @param b The symbol
+ * @param c The right part of the expression
+ * @return The newly created exception
+**/
 char* extract_unary_expr(char* a, char* b);
 
+/**
+ * Method used to extract a condition expression from components
+ * @param a The left size of the expression
+ * @param b The symbol
+ * @param c The right part of the expression
+ * @return The newly created exception
+**/
 char* extract_conditional_op(char* a, char* b, char* c);
 #endif

utilities.h

@@ -3,21 +3,70 @@
 #include <string>
 #include <vector>
 
+/**
+ * Method used to remove spaces preceding the string
+ * @param the string to trim
+ * @return the newwly created string
+**/
 std::string& ltrim(std::string &s);
 
+/**
+ * Method used to remove spaces following the string
+ * @param the string to trim
+ * @return the newwly created string
+**/
 std::string& rtrim(std::string& s);
 
+/**
+ * Method used to remove spaces following and preceding the string
+ * @param the string to trim
+ * @return the newwly created string
+**/
 std::string& trim(std::string& s);
 
+/**
+ * Split a string using the passed delimiter and put parts into the passed vector
+ * @param s The string to split
+ * @param delim The delimitation character
+ * @param elems The vector to fill
+ * @return the same vector passed in input
+**/
 std::vector<std::string>& split(const std::string& s, char delim, std::vector<std::string>& elems);
 
+/**
+ * Split a string using the given delimiter
+ * @param s the string to split
+ * @param delim the delimitation character
+ * @return a vector containing all string parts
+**/
 std::vector<std::string> split(const std::string& s, char delim);
 
+/**
+ * Method used to convert a day representation from string to integer (Mon -> 1, ecc...)
+ * @param s the string containing the day name
+ * @return a string containing the integer represenation of the day
+**/
 std::string sday2iday(const std::string& s);
 
+/**
+ * Method used to convert a month representation from string to integer (Jun -> 6, ecc...)
+ * @param s the string containing the month name
+ * @return a string containing the integer represenation of the month
+**/
 std::string smonth2imonth(const std::string& s);
 
+/**
+ * Checks if the string is a valid number for the specified base
+ * @param pszInput The input string
+ * @param nNumberBase The numeric base used to do the check
+ * @return true if the string is valid, false otherwise
+**/
 bool isNumeric( const char* pszInput, int nNumberBase );
 
+/**
+ * Method used to split a string using spaces as delimiters
+ * @param s The string to split
+ * @return a vector containing all string parts
+**/
 std::vector<std::string> string_split(const std::string& s);
 #endif