Added comments

bblanchon · bblanchon · commit 58c051f564f1 · 2014-09-01T21:36:09.000+02:00
diff --git a/JsonGenerator/IndentedPrint.h b/JsonGenerator/IndentedPrint.h
@@ -11,6 +11,9 @@ namespace ArduinoJson
 {
     namespace Generator
     {
+        // Decorator on top of Print to allow indented output.
+        // This class is used by JsonPrintable::prettyPrintTo() but can also be used
+        // for your own purpose, like logging.
         class IndentedPrint : public Print
         {
         public:
@@ -25,8 +28,13 @@ namespace ArduinoJson
 
             virtual size_t write(uint8_t);
 
+            // Adds one level of indentation
             void indent();
+
+            // Removes one level of indentation
             void unindent();
+
+            // Set the number of space printed for each level of indentation
             void setTabSize(uint8_t n);
 
         private:
diff --git a/JsonGenerator/JsonPrettyPrint.h b/JsonGenerator/JsonPrettyPrint.h
@@ -12,6 +12,7 @@ namespace ArduinoJson
 {
     namespace Generator
     {
+        // Converts a compact JSON string into an indented one.
         class JsonPrettyPrint : public Print
         {
         public:
diff --git a/JsonGenerator/JsonPrintable.h b/JsonGenerator/JsonPrintable.h
@@ -13,16 +13,27 @@ namespace ArduinoJson
 {
     namespace Generator
     {
+        // Contains methods to generate a JSON string.
+        // Implemented by both JsonObject and JsonArray
         class JsonPrintable : public Printable
         {
         public:
 
+            // Generates the compact JSON string and sends it to a Print stream 
             virtual size_t printTo(Print& p) const = 0;
 
+            // Generates the compact JSON string and writes it in a buffer
             size_t printTo(char* buffer, size_t bufferSize) const;
 
-            size_t prettyPrintTo(IndentedPrint& p) const;
+            // Generates the indented JSON string and sends it to a Print stream
             size_t prettyPrintTo(Print& p) const;
+
+            // Generates the indented JSON string and sends it to a IndentedPrint stream
+            // This overload allows a finer control of the output because you can customize
+            // the IndentedPrint.
+            size_t prettyPrintTo(IndentedPrint& p) const;
+
+            // Generates the indented JSON string and writes it in a buffer
             size_t prettyPrintTo(char* buffer, size_t bufferSize) const;
         };
     }

Original file line number	Diff line number	Diff line change
`@@ -12,6 +12,7 @@ namespace ArduinoJson`
`12`	`12`	`{`
`13`	`13`	`namespace Generator`
`14`	`14`	`{`
	`15`	`+ // Converts a compact JSON string into an indented one.`
`15`	`16`	`class JsonPrettyPrint : public Print`
`16`	`17`	`{`
`17`	`18`	`public:`