Changeset 13188

Timestamp:

03/24/08 20:06:41 (8 months ago)

Author:

peller

Message:

Clean up docs. Refs #5962 !strict

Files:

• dojo/trunk/_base/json.js (modified) (5 diffs)

dojo/trunk/_base/json.js

@@ -3 +3 @@
 dojo.fromJson = function(/*String*/ json){
         // summary:
-        //              evaluates the passed string-form of a JSON object
+        //              Parses a [JSON](http://json.org) string to return a JavaScript object.
         // json: 
         //              a string literal of a JSON item, for instance:
-        //                      '{ "foo": [ "bar", 1, { "baz": "thud" } ] }'
-        // return:
-        //              An object, the result of the evaluation
+        //                      `'{ "foo": [ "bar", 1, { "baz": "thud" } ] }'`
 
-        return eval("(" + json + ")");
+        return eval("(" + json + ")"); // Object
 }
 
@@ -26 +24 @@
 dojo.toJson = function(/*Object*/ it, /*Boolean?*/ prettyPrint, /*String?*/ _indentStr){
         // summary:
-        //              Create a JSON serialization of an object. 
+        //              Returns a [JSON](http://json.org) serialization of an object.
+        //
+        // description:
+        //              Returns a [JSON](http://json.org) serialization of an object.
         //              Note that this doesn't check for infinite recursion, so don't do that!
         //
@@ -43 +44 @@
         // _indentStr:
         //              private variable for recursive calls when pretty printing, do not use.
-        //              
-        // return:
-        //              a String representing the serialized version of the passed object.
 
         if(it === undefined){
@@ -109 +107 @@
         */
         if(objtype == "function"){
-                return null;
+                return null; // null
         }
         // generic object code path
@@ -132 +130 @@
                 output.push(newLine + nextIndent + keyStr + ":" + sep + val);
         }
-        return "{" + output.join("," + sep) + newLine + _indentStr + "}";
+        return "{" + output.join("," + sep) + newLine + _indentStr + "}"; // String
 }