fix typo

Author: dota17

example/README.md

@@ -1,13 +1,13 @@
 ***NOTE*** 
 
 If you get linker errors about undefined references to symbols that involve types in the `std::__cxx11` namespace or the tag
-`[abi:cxx11]` then it probably indicates that you are trying to link together object files that were compiles with different
+`[abi:cxx11]` then it probably indicates that you are trying to link together object files that were compiled with different
 values for the _GLIBCXX_USE_CXX11_ABI marco. This commonly happens when linking to a third-party library that was compiled with 
-an older version of GCC. If the third-party library cannot be rebuilt with the new ABI then you need to recompole your code with
-the old ABI,just like :
+an older version of GCC. If the third-party library cannot be rebuilt with the new ABI, then you need to recompile your code with
+the old ABI,just like:
 **g++ stringWrite.cpp -ljsoncpp -std=c++11 -D_GLIBCXX_USE_CXX11_ABI=0 -o stringWrite**
 
-Not all of uses of the new ABI will cause changes in symbol names,for example a class with a `std::string` member  variable will
-have the same mangled bane whether compiled with the older or new ABI. In order to detect such problems the new types and functions
-asre annotated with the abi_tag attribute,allowing the compiler to warn about potential ABI incompatibilities in code using them.
-Those warnings can be enabled with the `-Wabi-tag` option.
+Not all of uses of the new ABI will cause changes in symbol names, for example a class with a `std::string` member variable will
+have the same mangled name whether compiled with the older or new ABI. In order to detect such problems, the new types and functions
+are annotated with the abi_tag attribute, allowing the compiler to warn about potential ABI incompatibilities in code using them.
+Those warnings can be enabled with the `-Wabi-tag` option.

example/readFromStream/readFromStream.cpp

@@ -1,24 +1,22 @@
 #include "json/json.h"
 #include <fstream>
 #include <iostream>
-/*
-parse from stream,collect comments and capture error info.
-
-$g++ readFromStream.cpp -ljsoncpp -std=c++11 -o readFromStream
-$./readFromStream
-// comment head
-{
-    // comment before
-    "key" : "value"
-}
-// comment after
-// comment tail
-*/
+/** \brief Parse from stream, collect comments and capture error info.
+ * Example Usage:
+ * $g++ readFromStream.cpp -ljsoncpp -std=c++11 -o readFromStream
+ * $./readFromStream
+ * // comment head
+ * {
+ *    // comment before
+ *    "key" : "value"
+ * }
+ * // comment after
+ * // comment tail
+ */
 int main(int argc, char* argv[]) {
   Json::Value root;
   std::ifstream ifs;
   ifs.open(argv[1]);
-  root.clear();
 
   Json::CharReaderBuilder builder;
   builder["collectComments"] = true;

example/readFromString/readFromString.cpp

@@ -1,33 +1,37 @@
 #include "json/json.h"
 #include <iostream>
-/*
-parse a string to Value object with CharReaderBuilder class or Reader class
-$g++ readFromString.cpp -ljsoncpp -std=c++11 -o readFromString
-$./readFromString
-colin
-20
-*/
+/**
+ * \brief Parse a raw string into Value object using the CharReaderBuilder
+ * class, or the legacy Reader class. 
+ * Example Usage: 
+ * $g++ readFromString.cpp -ljsoncpp -std=c++11 -o readFromString
+ * $./readFromString
+ * colin
+ * 20
+ */
 int main() {
-  std::string strRes = R"({"Age": 20, "Name": "colin"})";
-  auto nLen = (int)strRes.length();
+  const std::string rawJson = R"({"Age": 20, "Name": "colin"})";
+  const int rawJsonLength = static_cast<int>(rawJson.length());
+  constexpr bool shouldUseOldWay = false;
   JSONCPP_STRING err;
   Json::Value root;
 
-#if 0 // old way
-    Json::Reader myreader;
-    myreader.parse(strRes,root);
-#else // new way
-  Json::CharReaderBuilder builder;
-  std::unique_ptr<Json::CharReader> const reader(builder.newCharReader());
-  if (!reader->parse(strRes.c_str(), strRes.c_str() + nLen, &root, &err)) {
-    std::cout << "error" << std::endl;
-    return EXIT_FAILURE;
+  if (shouldUseOldWay) {
+    Json::Reader reader;
+    reader.parse(rawJson, root);
+  } else {
+    Json::CharReaderBuilder builder;
+    std::unique_ptr<Json::CharReader> const reader(builder.newCharReader());
+    if (!reader->parse(rawJson.c_str(), rawJson.c_str() + rawJsonLength, &root,
+                       &err)) {
+      std::cout << "error" << std::endl;
+      return EXIT_FAILURE;
+    }
   }
-#endif
-  std::string strName = root["Name"].asString();
-  int strAge = root["Age"].asInt();
+  const std::string name = root["Name"].asString();
+  const int age = root["Age"].asInt();
 
-  std::cout << strName << std::endl;
-  std::cout << strAge << std::endl;
+  std::cout << name << std::endl;
+  std::cout << age << std::endl;
   return EXIT_SUCCESS;
 }

example/streamWrite/streamWrite.cpp

@@ -1,18 +1,18 @@
 #include "json/json.h"
 #include <iostream>
-/*
-write the Value object to stream
-$g++ streamWrite.cpp -ljsoncpp -std=c++11 -o streamWrite
-$./streamWrite
-{
-    "Age" : 20,
-    "Name" : "robin"
-}
-*/
+/** \brief Write the Value object to a stream.
+ * Example Usage:
+ * $g++ streamWrite.cpp -ljsoncpp -std=c++11 -o streamWrite
+ * $./streamWrite
+ * {
+ *     "Age" : 20,
+ *     "Name" : "robin"
+ * }
+ */
 int main() {
   Json::Value root;
   Json::StreamWriterBuilder builder;
-  std::unique_ptr<Json::StreamWriter> const writer(builder.newStreamWriter());
+  const std::unique_ptr<Json::StreamWriter> writer(builder.newStreamWriter());
 
   root["Name"] = "robin";
   root["Age"] = 20;

example/stringWrite/stringWrite.cpp

@@ -1,33 +1,33 @@
 #include "json/json.h"
 #include <iostream>
-/*
-write a Value object to a string
-$g++ stringWrite.cpp -ljsoncpp -std=c++11 -o stringWrite
-$./stringWrite
-{
-    "action" : "run",
-    "data" :
-    {
-        "number" : 1
-    }
-}
-*/
+/** \brief Write a Value object to a string.
+ * Example Usage:
+ * $g++ stringWrite.cpp -ljsoncpp -std=c++11 -o stringWrite
+ * $./stringWrite
+ * {
+ *     "action" : "run",
+ *     "data" :
+ *     {
+ *         "number" : 1
+ *     }
+ * }
+ */
 int main() {
-
   Json::Value root;
-  Json::Value t_data;
-
+  Json::Value data;
+  constexpr bool shouldUseOldWay = false;
   root["action"] = "run";
-  t_data["number"] = 1;
-  root["data"] = t_data;
+  data["number"] = 1;
+  root["data"] = data;
 
-#if 0 // old way
+  if (shouldUseOldWay) {
     Json::FastWriter writer;
-    std::string json_file = writer.write(root);
-#else // new way
-  Json::StreamWriterBuilder builder;
-  std::string json_file = Json::writeString(builder, root);
-#endif
-  std::cout << json_file << std::endl;
+    const std::string json_file = writer.write(root);
+    std::cout << json_file << std::endl;
+  } else {
+    Json::StreamWriterBuilder builder;
+    const std::string json_file = Json::writeString(builder, root);
+    std::cout << json_file << std::endl;
+  }
   return EXIT_SUCCESS;
 }

src/lib_json/CMakeLists.txt

@@ -87,7 +87,7 @@ endif()
 # See https://cmake.org/cmake/help/v3.1/prop_gbl/CMAKE_CXX_KNOWN_FEATURES.html#prop_gbl:CMAKE_CXX_KNOWN_FEATURES
 # for complete list of features available
 target_compile_features(jsoncpp_lib PUBLIC
-#        cxx_std_11 # Compiler mode is aware of C++ 11.
+        cxx_std_11 # Compiler mode is aware of C++ 11.
         #MSVC 1900 cxx_alignas # Alignment control alignas, as defined in N2341.
         #MSVC 1900 cxx_alignof # Alignment control alignof, as defined in N2341.
         #MSVC 1900 cxx_attributes # Generic attributes, as defined in N2761.