Doc update

dragonflydb · May 4, 2020 · 609b3b3 · 609b3b3
1 parent 1eb5d33
commit 609b3b3
Show file tree

Hide file tree

Showing 13 changed files with 117 additions and 108 deletions.
diff --git a/ChangeLog.md b/ChangeLog.md
@@ -19,6 +19,8 @@ Bug fixes:
 
 - Fixed OSS-Fuzz stack overflow issues [\#225](https://github.com/danielaparker/jsoncons/issues/225)
 
+- OSS-Fuzz failed throw issue in CBOR parser [\#235](https://github.com/danielaparker/jsoncons/issues/235)
+
 Changes:
 
 - The cbor_option name `enable_typed_arrays` has been deprecated and

diff --git a/README.md b/README.md
@@ -365,20 +365,20 @@ Output:
 ```
 Marilyn C
 begin_object
-name: application
+key: application
 string_value: hiking
-name: reputons
+key: reputons
 begin_array
 begin_object
-name: rater
+key: rater
 string_value: HikingAsylum
-name: assertion
+key: assertion
 string_value: advanced
-name: rated
+key: rated
 string_value: Marilyn C
-name: rating
+key: rating
 double_value: 0.9
-name: confidence
+key: confidence
 double_value: 0.99
 end_object
 end_array
@@ -417,7 +417,7 @@ int main()
         {
             case staj_event_type::string_value:
                 // Or std::string_view, if supported
-                std::cout << "string_value: " << event.get<jsoncons::string_view>() << "\n";
+                std::cout << event.event_type() << ": " << event.get<jsoncons::string_view>() << "\n";
                 break;
             default:
                 std::cout << "Unhandled event type\n";

diff --git a/doc/Examples.md b/doc/Examples.md
@@ -386,31 +386,31 @@ Output:
 ```
 begin_array
 begin_object
-name: author
+key: author
 string_value: Haruki Murakami
-name: title
+key: title
 string_value: Hard-Boiled Wonderland and the End of the World
-name: isbn
+key: isbn
 string_value: 0679743464
-name: publisher
+key: publisher
 string_value: Vintage
-name: date
+key: date
 string_value: 1993-03-02
-name: price
+key: price
 double_value: 19
 end_object
 begin_object
-name: author
+key: author
 string_value: Graham Greene
-name: title
+key: title
 string_value: The Comedians
-name: isbn
+key: isbn
 string_value: 0099478374
-name: publisher
+key: publisher
 string_value: Vintage Classics
-name: date
+key: date
 string_value: 2005-09-21
-name: price
+key: price
 double_value: 16
 end_object
 end_array

diff --git a/doc/Pages/index.md b/doc/Pages/index.md
@@ -314,20 +314,20 @@ Output:
 ```
 Marilyn C
 begin_object
-name: application
+key: application
 string_value: hiking
-name: reputons
+key: reputons
 begin_array
 begin_object
-name: rater
+key: rater
 string_value: HikingAsylum
-name: assertion
+key: assertion
 string_value: advanced
-name: rated
+key: rated
 string_value: Marilyn C
-name: rating
+key: rating
 double_value: 0.9
-name: confidence
+key: confidence
 double_value: 0.99
 end_object
 end_array

diff --git a/doc/ref/basic_json_cursor.md b/doc/ref/basic_json_cursor.md
@@ -170,39 +170,39 @@ int main()
         switch (event.event_type())
         {
             case staj_event_type::begin_array:
-                std::cout << "begin_array\n";
+                std::cout << event.event_type() << "\n";
                 break;
             case staj_event_type::end_array:
-                std::cout << "end_array\n";
+                std::cout << event.event_type() << "\n";
                 break;
             case staj_event_type::begin_object:
-                std::cout << "begin_object\n";
+                std::cout << event.event_type() << "\n";
                 break;
             case staj_event_type::end_object:
-                std::cout << "end_object\n";
+                std::cout << event.event_type() << "\n";
                 break;
             case staj_event_type::key:
                 // Or std::string_view, if supported
-                std::cout << "name: " << event.get<jsoncons::string_view>() << "\n";
+                std::cout << event.event_type() << ": " << event.get<jsoncons::string_view>() << "\n";
                 break;
             case staj_event_type::string_value:
                 // Or std::string_view, if supported
-                std::cout << "string_value: " << event.get<jsoncons::string_view>() << "\n";
+                std::cout << event.event_type() << ": " << event.get<jsoncons::string_view>() << "\n";
                 break;
             case staj_event_type::null_value:
-                std::cout << "null_value: " << "\n";
+                std::cout << event.event_type() << ": " << "\n";
                 break;
             case staj_event_type::bool_value:
-                std::cout << "bool_value: " << std::boolalpha << event.get<bool>() << "\n";
+                std::cout << event.event_type() << ": " << std::boolalpha << event.get<bool>() << "\n";
                 break;
             case staj_event_type::int64_value:
-                std::cout << "int64_value: " << event.get<int64_t>() << "\n";
+                std::cout << event.event_type() << ": " << event.get<int64_t>() << "\n";
                 break;
             case staj_event_type::uint64_value:
-                std::cout << "uint64_value: " << event.get<uint64_t>() << "\n";
+                std::cout << event.event_type() << ": " << event.get<uint64_t>() << "\n";
                 break;
             case staj_event_type::double_value:
-                std::cout << "double_value: " << event.get<double>() << "\n";
+                std::cout << event.event_type() << ": " << event.get<double>() << "\n";
                 break;
             default:
                 std::cout << "Unhandled event type\n";
@@ -215,31 +215,31 @@ Output:
 ```
 begin_array
 begin_object
-name: author
+key: author
 string_value: Haruki Murakami
-name: title
+key: title
 string_value: Hard-Boiled Wonderland and the End of the World
-name: isbn
+key: isbn
 string_value: 0679743464
-name: publisher
+key: publisher
 string_value: Vintage
-name: date
+key: date
 string_value: 1993-03-02
-name: price
+key: price
 double_value: 19
 end_object
 begin_object
-name: author
+key: author
 string_value: Graham Greene
-name: title
+key: title
 string_value: The Comedians
-name: isbn
+key: isbn
 string_value: 0099478374
-name: publisher
+key: publisher
 string_value: Vintage Classics
-name: date
+key: date
 string_value: 2005-09-21
-name: price
+key: price
 double_value: 16
 end_object
 end_array

diff --git a/doc/ref/bson/basic_bson_cursor.md b/doc/ref/bson/basic_bson_cursor.md
@@ -138,39 +138,39 @@ int main()
         switch (event.event_type())
         {
             case staj_event_type::begin_array:
-                std::cout << "begin_array\n";
+                std::cout << event.event_type() << "\n";
                 break;
             case staj_event_type::end_array:
-                std::cout << "end_array\n";
+                std::cout << event.event_type() << "\n";
                 break;
             case staj_event_type::begin_object:
-                std::cout << "begin_object\n";
+                std::cout << event.event_type() << "\n";
                 break;
             case staj_event_type::end_object:
-                std::cout << "end_object\n";
+                std::cout << event.event_type() << "\n";
                 break;
             case staj_event_type::key:
                 // Or std::string_view, if supported
-                std::cout << "name: " << event.get<jsoncons::string_view>() << "\n";
+                std::cout << event.event_type() << ": " << event.get<jsoncons::string_view>() << "\n";
                 break;
             case staj_event_type::string_value:
                 // Or std::string_view, if supported
-                std::cout << "string_value: " << event.get<jsoncons::string_view>() << "\n";
+                std::cout << event.event_type() << ": " << event.get<jsoncons::string_view>() << "\n";
                 break;
             case staj_event_type::null_value:
-                std::cout << "null_value: " << "\n";
+                std::cout << event.event_type() << ": " << "\n";
                 break;
             case staj_event_type::bool_value:
-                std::cout << "bool_value: " << std::boolalpha << event.get<bool>() << "\n";
+                std::cout << event.event_type() << ": " << std::boolalpha << event.get<bool>() << "\n";
                 break;
             case staj_event_type::int64_value:
-                std::cout << "int64_value: " << event.get<int64_t>() << "\n";
+                std::cout << event.event_type() << ": " << event.get<int64_t>() << "\n";
                 break;
             case staj_event_type::uint64_value:
-                std::cout << "uint64_value: " << event.get<uint64_t>() << "\n";
+                std::cout << event.event_type() << ": " << event.get<uint64_t>() << "\n";
                 break;
             case staj_event_type::double_value:
-                std::cout << "double_value: " << event.get<double>() << "\n";
+                std::cout << event.event_type() << ": " << event.get<double>() << "\n";
                 break;
             default:
                 std::cout << "Unhandled event type\n";
@@ -183,31 +183,31 @@ Output:
 ```
 begin_array
 begin_object
-name: author
+key: author
 string_value: Haruki Murakami
-name: title
+key: title
 string_value: Hard-Boiled Wonderland and the End of the World
-name: isbn
+key: isbn
 string_value: 0679743464
-name: publisher
+key: publisher
 string_value: Vintage
-name: date
+key: date
 string_value: 1993-03-02
-name: price
+key: price
 double_value: 19
 end_object
 begin_object
-name: author
+key: author
 string_value: Graham Greene
-name: title
+key: title
 string_value: The Comedians
-name: isbn
+key: isbn
 string_value: 0099478374
-name: publisher
+key: publisher
 string_value: Vintage Classics
-name: date
+key: date
 string_value: 2005-09-21
-name: price
+key: price
 double_value: 16
 end_object
 end_array

diff --git a/doc/ref/bson/bson.md b/doc/ref/bson/bson.md
@@ -12,6 +12,8 @@ data structures, using [json_type_traits](../json_type_traits.md).
 
 [basic_bson_encoder](basic_bson_encoder.md)
 
+[bson_options](bson_options.md)
+
 #### Mappings between BSON and jsoncons data items
 
 BSON data item  | jsoncons data item  |jsoncons tag