Changeset 3875

Timestamp:

08/11/08 16:36:02 (4 months ago)

Author:

kris

Message:

added a bit of doc

Files:

• trunk/tango/text/json/Json.d (modified) (5 diffs)

trunk/tango/text/json/Json.d

@@ -20 +20 @@
-private import Float = tango.text.convert.Float;
-
-
-
-/**
- * Enumerates the seven acceptable JSON value types.
- */
-/**
- * Represents a JSON value that is one of the seven types specified by the enum
- * Type.
- */
-/**
- * Represents a single JSON Object.
- */
-
-/*******************************************************************************
+
+        Parse JSON text into a set of inter-related structures. Typical usage 
+        is as follows:
+        ---
+        auto p = new Json!(char);
+        auto v = p.parse (`{"t": true, "n":null, "array":["world", [4, 5]]}`);    
+        ---   
+
+        Converting back to text format employs a delegate:
+        ---
+        v.print ((char[] s) {Stdout(s);}); 
+        ---
-
-*******************************************************************************/
@@ -39 +38 @@
-class Json(T) : private JsonParser!(T)
-{
+                     /// use these types for external references
-        public alias JsonValue*  Value;
-        public alias NameValue*  Attribute;
-        public alias JsonObject* Composite;
-
+                    /// enumerates the seven acceptable JSON value types
-        public enum Type {Null, String, RawString, Number, Object, Array, True, False};
-
-        /***********************************************************************
-        
+                Construct a json instance
+
-        ***********************************************************************/
-        
@@ -56 +59 @@
-        /***********************************************************************
-        
+                Parse the given text and return a resultant Value type 
+
-        ***********************************************************************/
-        
-        public Value parse (T[] json)
-        {
-
-                nesting = 0;
-                attrib.reset;
@@ -327 +331 @@
-
-        /***********************************************************************
-
+
+
+
-        ***********************************************************************/
-        
@@ -420 +426 @@
-        /***********************************************************************
-        
+                Represents a json value that is one of the seven types 
+                specified via the Json.Type enum 
+
-        ***********************************************************************/
-