clarify Builders

cdunn2001 · cdunn2001 · commit 66a8ba255f2d · 2015-02-09T01:29:43.000-06:00
diff --git a/doc/jsoncpp.dox b/doc/jsoncpp.dox
@@ -50,16 +50,8 @@ preserved.
 \section _example Code example
 
 \code
-Json::Value root;   // will contain the root value after parsing.
-Json::Reader reader;
-bool parsingSuccessful = reader.parse( config_doc, root );
-if ( !parsingSuccessful )
-{
-    // report to the user the failure and their locations in the document.
-    std::cout  << "Failed to parse configuration\n"
-               << reader.getFormattedErrorMessages();
-    return;
-}
+Json::Value root;   // 'root' will contain the root value after parsing.
+std::cin >> root;   // Or see CharReaderBuilder.
 
 // Get the value of the member of root named 'encoding', return 'UTF-8' if there is no
 // such member.
@@ -80,7 +72,7 @@ root["indent"]["length"] = getCurrentIndentLength();
 root["indent"]["use_space"] = getCurrentIndentUseSpace();
 
 // (NEW IN 1.4.0)
-// To write into a steam with minimal memory overhead,
+// To write into a stream with minimal memory overhead,
 // create a Builder for a StreamWriter.
 Json::StreamWriterBuilder builder;
 builder.indentation_ = "   ";  // or whatever you like
diff --git a/include/json/reader.h b/include/json/reader.h
@@ -274,21 +274,27 @@ class JSON_API CharReader {
   };  // Factory
 };  // CharReader
 
+/** \brief Build a CharReader implementation.
+
+Usage:
+\code
+  using namespace Json;
+  CharReaderBuilder builder;
+  builder.collectComments_ = true;
+  std::shared_ptr<CharReader> reader(
+    builder.newCharReader());
+  Value value;
+  std::string errs;
+  bool ok = parseFromStream(std::cin, &value, &errs);
+\endcode
+*/
 class CharReaderBuilder : public CharReader::Factory {
+public:
   bool collectComments_;
   Features features_;
-public:
-  CharReaderBuilder();
-
-  CharReaderBuilder& withCollectComments(bool v) {
-    collectComments_ = v;
-    return *this;
-  }
 
-  CharReaderBuilder& withFeatures(Features const& v) {
-    features_ = v;
-    return *this;
-  }
+  CharReaderBuilder();
+  virtual ~CharReaderBuilder();
 
   virtual CharReader* newCharReader() const;
 };
diff --git a/include/json/writer.h b/include/json/writer.h
@@ -105,9 +105,10 @@ class JSON_API StreamWriterBuilder : public StreamWriter::Factory {
   std::string indentation_;
 
   StreamWriterBuilder();
+  virtual ~StreamWriterBuilder();
 
   /// Do not take ownership of sout, but maintain a reference.
-  StreamWriter* newStreamWriter(std::ostream* sout) const;
+  virtual StreamWriter* newStreamWriter(std::ostream* sout) const;
 };
 
 /** \brief Build a StreamWriter implementation.
diff --git a/src/lib_json/json_reader.cpp b/src/lib_json/json_reader.cpp
@@ -915,6 +915,8 @@ CharReaderBuilder::CharReaderBuilder()
   : collectComments_(true)
   , features_(Features::all())
 {}
+CharReaderBuilder::~CharReaderBuilder()
+{}
 CharReader* CharReaderBuilder::newCharReader() const
 {
   return new OldReader(collectComments_, features_);
diff --git a/src/lib_json/json_writer.cpp b/src/lib_json/json_writer.cpp
@@ -971,6 +971,8 @@ StreamWriterBuilder::StreamWriterBuilder()
   : cs_(StreamWriter::CommentStyle::All)
   , indentation_("\t")
 {}
+StreamWriterBuilder::~StreamWriterBuilder()
+{}
 StreamWriter* StreamWriterBuilder::newStreamWriter(std::ostream* stream) const
 {
   std::string colonSymbol = " : ";

Original file line number	Diff line number	Diff line change
`@@ -915,6 +915,8 @@ CharReaderBuilder::CharReaderBuilder()`
`915`	`915`	`: collectComments_(true)`
`916`	`916`	`, features_(Features::all())`
`917`	`917`	`{}`
	`918`	`+CharReaderBuilder::~CharReaderBuilder()`
	`919`	`+{}`
`918`	`920`	`CharReader* CharReaderBuilder::newCharReader() const`
`919`	`921`	`{`
`920`	`922`	`return new OldReader(collectComments_, features_);`
Original file line number	Diff line number	Diff line change
`@@ -971,6 +971,8 @@ StreamWriterBuilder::StreamWriterBuilder()`
`971`	`971`	`: cs_(StreamWriter::CommentStyle::All)`
`972`	`972`	`, indentation_("\t")`
`973`	`973`	`{}`
	`974`	`+StreamWriterBuilder::~StreamWriterBuilder()`
	`975`	`+{}`
`974`	`976`	`StreamWriter* StreamWriterBuilder::newStreamWriter(std::ostream* stream) const`
`975`	`977`	`{`
`976`	`978`	`std::string colonSymbol = " : ";`