瀏覽代碼

Added comments

Benoit Blanchon 11 年之前
父節點
當前提交
0fc54ba54c
共有 2 個文件被更改,包括 9 次插入0 次删除
  1. 5 0
      JsonParser/JsonObjectIterator.h
  2. 4 0
      JsonParser/JsonPair.h

+ 5 - 0
JsonParser/JsonObjectIterator.h

@@ -13,25 +13,30 @@ namespace ArduinoJson
 {
 {
     namespace Parser
     namespace Parser
     {
     {
+        // An iterator for JsonObject
         class JsonObjectIterator : JsonToken
         class JsonObjectIterator : JsonToken
         {
         {
         public:
         public:
 
 
+            // Create an iterator pointing at the specified token
             JsonObjectIterator(JsonToken token)
             JsonObjectIterator(JsonToken token)
                 : JsonToken(token)
                 : JsonToken(token)
             {
             {
             }
             }
 
 
+            // Move to the next JsonPair
             void operator++()
             void operator++()
             {
             {
                 *this = JsonObjectIterator(nextSibling().nextSibling());
                 *this = JsonObjectIterator(nextSibling().nextSibling());
             }
             }
 
 
+            // Get the JsonPair pointed by the iterator
             JsonPair operator*() const
             JsonPair operator*() const
             {
             {
                 return JsonPair(*this);
                 return JsonPair(*this);
             }
             }
 
 
+            // Test iterator equality
             bool operator!= (const JsonObjectIterator& other) const
             bool operator!= (const JsonObjectIterator& other) const
             {
             {
                 return JsonToken::operator!=(other);
                 return JsonToken::operator!=(other);

+ 4 - 0
JsonParser/JsonPair.h

@@ -11,20 +11,24 @@ namespace ArduinoJson
 {
 {
     namespace Parser
     namespace Parser
     {
     {
+        // A JSON key-value pair, as a part of a JSON object
         class JsonPair : JsonToken
         class JsonPair : JsonToken
         {
         {
         public:
         public:
+            // Convert a JsonToken to a JsonPair
             JsonPair(JsonToken token)
             JsonPair(JsonToken token)
                 : JsonToken(token)
                 : JsonToken(token)
             {
             {
 
 
             }
             }
 
 
+            // Get the key
             const char* key()
             const char* key()
             {
             {
                 return getText();
                 return getText();
             }
             }
 
 
+            // Get the value
             JsonValue value()
             JsonValue value()
             {
             {
                 return nextSibling();
                 return nextSibling();