Added comments

include/ArduinoJson/JsonObject.hpp

@@ -86,6 +86,7 @@ class JsonObject : public Internals::JsonPrintable<JsonObject>,
   // This is used when memory allocation or JSON parsing fail.
   static JsonObject &invalid() { return _invalid; }
 
+  // Serialize the object to the specified JsonWriter
   template <typename T>
   void writeTo(T &writer) const;
 

include/ArduinoJson/JsonPair.hpp

@@ -10,6 +10,7 @@
 
 namespace ArduinoJson {
 
+// A key value pair for JsonObject.
 struct JsonPair {
   const char* key;
   JsonVariant value;

include/ArduinoJson/JsonVariant.hpp

@@ -15,106 +15,170 @@
 
 namespace ArduinoJson {
 
+// Forward declarations.
 class JsonArray;
 class JsonObject;
 
+// A variant that can be a any value serializable to a JSON value.
+//
+// It can be set to:
+// - a boolean
+// - a char, short, int or a long (signed or unsigned)
+// - a string (const char*)
+// - a reference to a JsonArray or JsonObject
 class JsonVariant : public Internals::JsonPrintable<JsonVariant> {
  public:
+  // Creates an uninitialized JsonVariant
   JsonVariant() : _type(Internals::JSON_UNDEFINED) {}
 
+  // Initializes a JsonVariant with the specified value.
   template <typename T>
   explicit JsonVariant(T value) {
     set(value);
   }
 
+  // Tells weither the variant is valid.
+  bool success() {
+    return _type != Internals::JSON_INVALID &&
+           _type != Internals::JSON_UNDEFINED;
+  }
+
+  // Sets the variant to a boolean value.
+  // It will be serialized as "true" or "false" in JSON.
   void set(bool value);
+
+  // Sets the variant to a floating point value.
+  // The second argument specifies the number of decimal digits to write in
+  // the JSON string.
   void set(double value, uint8_t decimals = 2);
+
+  // Sets the variant to be an integer value.
+  void set(signed long value);
   void set(signed char value) { set(static_cast<long>(value)); }
   void set(signed int value) { set(static_cast<long>(value)); }
-  void set(signed long value);
   void set(signed short value) { set(static_cast<long>(value)); }
   void set(unsigned char value) { set(static_cast<long>(value)); }
   void set(unsigned int value) { set(static_cast<long>(value)); }
   void set(unsigned long value) { set(static_cast<long>(value)); }
   void set(unsigned short value) { set(static_cast<long>(value)); }
+
+  // Sets the variant to be a string.
   void set(const char *value);
+
+  // Sets the variant to be a reference to an array.
   void set(JsonArray &array);
+
+  // Sets the variant to be a reference to an object.
   void set(JsonObject &object);
 
+  // Sets the variant to the specified value.
   template <typename T>
   JsonVariant &operator=(T value) {
     set(value);
     return *this;
   }
 
+  // Sets the variant to be a reference to an array.
   JsonVariant &operator=(JsonArray &array) {
     set(array);
     return *this;
   }
 
+  // Sets the variant to be a reference to an object.
   JsonVariant &operator=(JsonObject &object) {
     set(object);
     return *this;
   }
 
+  // Gets the variant as a boolean value.
+  // Returns false if the variant is not a boolean value.
   operator bool() const;
+
+  // Gets the variant as a floating-point value.
+  // Returns 0.0 if the variant is not a floating-point value
   operator double() const;
   operator float() const { return static_cast<float>(as<double>()); }
-  operator signed char() const { return static_cast<signed char>(as<long>()); }
+
-  operator signed int() const { return static_cast<signed int>(as<long>()); }
+  // Gets the variant as an integer value.
+  // Returns 0 if the variant is not an integer value.
   operator signed long() const;
-  operator signed short() const {
+  operator signed char() const { return cast_long_to<signed char>(); }
-    return static_cast<signed short>(as<long>());
+  operator signed int() const { return cast_long_to<signed int>(); }
-  }
+  operator signed short() const { return cast_long_to<signed short>(); }
-  operator unsigned char() const {
+  operator unsigned char() const { return cast_long_to<unsigned char>(); }
-    return static_cast<unsigned char>(as<long>());
+  operator unsigned int() const { return cast_long_to<unsigned int>(); }
-  }
+  operator unsigned long() const { return cast_long_to<unsigned long>(); }
-  operator unsigned int() const {
+  operator unsigned short() const { return cast_long_to<unsigned short>(); }
-    return static_cast<unsigned int>(as<long>());
+
-  }
+  // Gets the variant as a string.
-  operator unsigned long() const {
+  // Returns NULL if variant is not a string.
-    return static_cast<unsigned long>(as<long>());
-  }
-  operator unsigned short() const {
-    return static_cast<unsigned short>(as<long>());
-  }
   operator const char *() const;
+  const char *asString() const { return as<const char *>(); }
+
+  // Gets the variant as an array.
+  // Returns a reference to the JsonArray or JsonArray::invalid() if the variant
+  // is not an array.
   operator JsonArray &() const;
+  JsonArray &asArray() const { return as<JsonArray &>(); }
+
+  // Gets the variant as an object.
+  // Returns a reference to the JsonObject or JsonObject::invalid() if the
+  // variant is not an object.
   operator JsonObject &() const;
+  JsonObject &asObject() const { return as<JsonObject &>(); }
 
-  const char *asString() const { return this->as<const char *>(); }
+  // Get the variant as the specified type.
-  JsonArray &asArray() const { return this->as<JsonArray &>(); }
+  // See cast operators for details.
-  JsonObject &asObject() const { return this->as<JsonObject &>(); }
-
   template <typename T>
   T as() const {
     return static_cast<T>(*this);
   }
 
+  // Tells weither the variant has the specified type.
+  // Returns true if the variant has type type T, false otherwise.
   template <typename T>
   bool is() const {
     return false;
   }
 
+  // Returns an invalid variant.
+  // This is meant to replace a NULL pointer.
   static JsonVariant &invalid() { return _invalid; }
 
-  bool success() {
+  // Serialize the variant to a JsonWriter
-    return _type != Internals::JSON_INVALID &&
-           _type != Internals::JSON_UNDEFINED;
-  }
-
   template <typename T>
   void writeTo(T &writer) const;
 
+  // Mimics an array or an object.
+  // Returns the size of the array or object if the variant has that type.
+  // Returns 0 if the variant is neither an array nor an object
   size_t size() const;
+
+  // Mimics an array.
+  // Returns the element at specified index if the variant is an array.
+  // Returns JsonVariant::invalid() if the variant is not an array.
   JsonVariant &operator[](int index);
+
+  // Mimics an object.
+  // Returns the value associated with the specified key if the variant is an
+  // object.
+  // Return JsonVariant::invalid() if the variant is not an object.
   JsonVariant &operator[](const char *key);
 
  private:
-  explicit JsonVariant(Internals::JsonVariantType type) : _type(type) {}
+  // Helper for interger cast operators
+  template <typename T>
+  T cast_long_to() const {
+    return static_cast<T>(as<long>());
+  }
 
+  // The current type of the variant
   Internals::JsonVariantType _type;
+
+  // The various alternatives for the value of the variant.
   Internals::JsonVariantContent _content;
+
+  // The instance returned by JsonVariant::invalid()
   static JsonVariant _invalid;
 };