Changeset 815 for firmware/trunk/libraries/json/json.h

Timestamp:

08/13/08 12:48:09 (5 months ago)

Author:

liamstask

Message:

- updated struct documentation: much better xbee doc

Files:

• firmware/trunk/libraries/json/json.h (modified) (2 diffs)

firmware/trunk/libraries/json/json.h

@@ -42 +42 @@
 typedef struct
 {
-  JsonEncode_Step steps[JSON_MAX_DEPTH];
-  int depth;
+  JsonEncode_Step steps[JSON_MAX_DEPTH]; /**< An array to keep track of the state of each step in the encoder. */
+  int depth;                             /**< The current depth of the encoder (how many elements have been opened). */
 } JsonEncode_State;
 
@@ -60 +60 @@
  */
 typedef struct {
-  JsonDecode_Step steps[JSON_MAX_DEPTH];
-  int depth;
-  bool gotcomma;
-  void* context;
-  char* p;
-  int len;
+  JsonDecode_Step steps[JSON_MAX_DEPTH]; /**< An array to keep track of each step of the decoder. */
+  int depth;                             /**< The current depth of the decoder (how many elements have been opened). */
+  bool gotcomma;                         /**< Used internally by the decoder. */
+  void* context;                         /**< A pointer to the user context. */
+  char* p;                               /**< A pointer to the data. */
+  int len;                               /**< The current length. */
 } JsonDecode_State;