clarify comments

cdunn2001 · cdunn2001 · commit 29501c4d9f08 · 2015-02-10T23:03:27.000-06:00
And throw instead of return null for invalid settings.
diff --git a/include/json/reader.h b/include/json/reader.h
@@ -299,10 +299,17 @@ class JSON_API CharReaderBuilder : public CharReader::Factory {
     These are case-sensitive.
     Available settings (case-sensitive):
     - "collectComments": false or true
-    - "allowComments"
-    - "strictRoot"
-    - "allowDroppedNullPlaceholders"
-    - "allowNumericKeys"
+      - true to collect comment and allow writing them
+        back during serialization, false to discard comments.
+        This parameter is ignored if allowComments is false.
+    - "allowComments": false or true
+      - true if comments are allowed.
+    - "strictRoot": false or true
+      - true if root must be either an array or an object value
+    - "allowDroppedNullPlaceholders": false or true
+      - true if dropped null placeholders are allowed. (See StreamWriterBuilder.)
+    - "allowNumericKeys": false or true
+      - true if numeric object keys are allowed.
 
     You can examine 'settings_` yourself
     to see the defaults. You can also write and read them just like any
diff --git a/include/json/writer.h b/include/json/writer.h
@@ -92,9 +92,9 @@ class JSON_API StreamWriterBuilder : public StreamWriter::Factory {
     Available settings (case-sensitive):
     - "commentStyle": "None" or "All"
     - "indentation":  "<anything>"
-    - "enableYAMLCompatibility": False or True
+    - "enableYAMLCompatibility": false or true
       - slightly change the whitespace around colons
-    - "dropNullPlaceholders": False or True
+    - "dropNullPlaceholders": false or true
       - Drop the "null" string from the writer's output for nullValues.
         Strictly speaking, this is not valid JSON. But when the output is being
         fed to a browser's Javascript, it makes for smaller output and the
diff --git a/src/lib_json/json_writer.cpp b/src/lib_json/json_writer.cpp
@@ -981,7 +981,7 @@ StreamWriter* StreamWriterBuilder::newStreamWriter() const
   } else if (cs_str == "None") {
     cs = CommentStyle::None;
   } else {
-    return NULL;
+    throw std::runtime_error("commentStyle must be 'All' or 'None'");
   }
   std::string colonSymbol = " : ";
   if (eyc) {

Original file line number	Diff line number	Diff line change
`@@ -981,7 +981,7 @@ StreamWriter* StreamWriterBuilder::newStreamWriter() const`
`981`	`981`	`} else if (cs_str == "None") {`
`982`	`982`	`cs = CommentStyle::None;`
`983`	`983`	`} else {`
`984`		`- return NULL;`
	`984`	`+ throw std::runtime_error("commentStyle must be 'All' or 'None'");`
`985`	`985`	`}`
`986`	`986`	`std::string colonSymbol = " : ";`
`987`	`987`	`if (eyc) {`