Merge pull request #1 from SlicingDice/feature/add-code-comments

Add code comments

Author: joaosimbiose

SlicingDice.cpp

@@ -19,12 +19,20 @@ SlicingDice::SlicingDice(const char* apiUserKey, const char* customHost, int cus
     apiKey = apiUserKey;
 }
 
+/* Index data on Slicing Dice API
+ *
+ * query - the query to send to Slicing Dice API
+ */
 void SlicingDice::index(JsonObject& query) {
     char queryConverted[query.measureLength() +  1];
     query.printTo(queryConverted, sizeof(queryConverted));
     makeRequest(queryConverted);
 }
 
+/* Make a HTTP request to Slicing Dice API 
+ * 
+ * query - the query to send to Slicing Dice API
+ */
 void SlicingDice::makeRequest(const char* query){
     client.connect(host, port);
     while (!client.connected()) {
@@ -42,6 +50,7 @@ void SlicingDice::makeRequest(const char* query){
     client.stop();
 }
 
+//Read response from HTTP request to Slicing Dice API
 void SlicingDice::readResponse(){
     response = " ";
     boolean currentLineIsBlank = true;

tests_and_examples/Simple.ino

@@ -9,7 +9,7 @@ void setup() {
     while (!Serial) {
     }
 
-    // Arduino network settings
+    // Arduino network settings, should match your internet connection properties
     byte mac[] = {  0xDE, 0xAD, 0xBE, 0xEF, 0xFE, 0xED };
     byte ip[] = { 192, 168, 1, 10 };
     byte gateway[] = { 192, 168, 1, 1 }; 
@@ -18,6 +18,7 @@ void setup() {
     Ethernet.begin(mac, ip, dnxs, gateway, subnet);
 }
 
+// Send an indexation command to Slicing Dice API and print the result
 void loop() {
     StaticJsonBuffer<200> jsonBuffer;
     JsonObject& queryIndex = jsonBuffer.createObject();