From b2f8d2c1e3c5b74518b5c5bb6c34fd8325e9ef1e Mon Sep 17 00:00:00 2001 From: danielaparker Date: Mon, 11 May 2020 13:26:04 -0400 Subject: [PATCH] Doc update --- README.md | 10 +++++----- doc/Pages/index.md | 4 ++-- doc/ref/cbor/cbor.md | 4 ++-- doc/ref/csv/csv.md | 5 ++--- doc/ref/msgpack/msgpack.md | 1 - doc/ref/ubjson/ubjson.md | 4 ++-- 6 files changed, 13 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index dc02f4c565..1a8236f6fc 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ to work with the data in a number of ways: - As a strongly typed C++ data structure that implements [json_type_traits](doc/ref/json_type_traits.md) -- As a stream of parse events, somewhat analogous to StAX pull parsing and push serializing +- With cursor-level access to a stream of parse events, somewhat analogous to StAX pull parsing and push serializing in the XML world. Compared to other JSON libraries, jsoncons has been designed to handle very large JSON texts. At its heart are @@ -130,7 +130,7 @@ jsoncons allows you to work with the data in a number of ways: - As a strongly typed C++ data structure that implements [json_type_traits](doc/ref/json_type_traits.md) -- As a stream of parse events +- With [cursor-level access](doc/ref/basic_json_cursor.md) to a stream of parse events #### As a variant-like data structure @@ -310,7 +310,7 @@ These macro declarations must be placed outside any namespace blocks. See [examples](doc/Examples.md#G0) for other ways of specializing `json_type_traits`. -#### As a stream of parse events +#### With cursor-level access ```c++ int main() @@ -482,7 +482,7 @@ jsoncons allows you to work with the CBOR data similarly to JSON data: - As a strongly typed C++ data structure that implements [json_type_traits](doc/ref/json_type_traits.md) -- As a stream of parse events +- With [cursor-level access](doc/ref/cbor/basic_cbor_cursor.md) to a stream of parse events #### As a variant-like data structure @@ -582,7 +582,7 @@ bar, 50 75 73 73, 1.23456789012345678901234567890 Note that when decoding the bigfloat and decimal fraction into a `std::string`, we lose the semantic information that the variant like data structure preserved with a tag, so serializing back to CBOR produces a text string. -#### As a stream of parse events +#### With cursor-level access ```c++ int main() diff --git a/doc/Pages/index.md b/doc/Pages/index.md index 360a5bacf5..0330b65617 100644 --- a/doc/Pages/index.md +++ b/doc/Pages/index.md @@ -31,7 +31,7 @@ to work with the data in a number of ways: - As a strongly typed C++ data structure that implements [json_type_traits](https://github.com/danielaparker/jsoncons/blob/master/doc/ref/json_type_traits.md) -- As a stream of parse events, somewhat analogous to StAX pull parsing and push serializing +- With [cursor-level access](https://github.com/danielaparker/jsoncons/blob/doc/doc/ref/basic_json_cursor.md) to a stream of parse events, somewhat analogous to StAX pull parsing and push serializing in the XML world. Compared to other JSON libraries, jsoncons has been designed to handle very large JSON texts. At its heart are @@ -258,7 +258,7 @@ These macro declarations must be placed outside any namespace blocks. See [examples](https://github.com/danielaparker/jsoncons/blob/master/doc/Examples.md#G1) for other ways of specializing `json_type_traits`. -#### As a stream of parse events +#### With cursor-level access ```c++ int main() diff --git a/doc/ref/cbor/cbor.md b/doc/ref/cbor/cbor.md index e2bf98e0cf..90402c31e7 100644 --- a/doc/ref/cbor/cbor.md +++ b/doc/ref/cbor/cbor.md @@ -158,7 +158,7 @@ jsoncons allows you to work with the CBOR data similarly to JSON data: - As a strongly typed C++ data structure that implements [json_type_traits](../json_type_traits.md) -- As a stream of parse events +- With [cursor-level access](doc/ref/cbor/basic_cbor_cursor.md) to a stream of parse events #### As a variant-like data structure @@ -258,7 +258,7 @@ bar, 50 75 73 73, 1.23456789012345678901234567890 Note that when decoding the bigfloat and decimal fraction into a `std::string`, we lose the semantic information that the variant like data structure preserved with a tag, so serializing back to CBOR produces a text string. -#### As a stream of parse events +#### With cursor-level access ```c++ int main() diff --git a/doc/ref/csv/csv.md b/doc/ref/csv/csv.md index 257df8a429..7df1404c70 100644 --- a/doc/ref/csv/csv.md +++ b/doc/ref/csv/csv.md @@ -37,8 +37,7 @@ jsoncons allows you to work with the CSV data similarly to JSON data: - As a strongly typed C++ data structure that implements [json_type_traits](../json_type_traits.md) -- As a stream of parse events - +- With [cursor-level access](doc/ref/csv/basic_csv_cursor.md) to a stream of parse events #### As a variant-like data structure @@ -194,7 +193,7 @@ EUR_LIBOR_06M,2015-10-26,0.0000143 EUR_LIBOR_06M,2015-10-27,0.0000001 ``` -#### As a stream of parse events +#### With cursor-level access ```c++ int main() diff --git a/doc/ref/msgpack/msgpack.md b/doc/ref/msgpack/msgpack.md index 0bc5e258d1..d057e9c75b 100644 --- a/doc/ref/msgpack/msgpack.md +++ b/doc/ref/msgpack/msgpack.md @@ -4,7 +4,6 @@ The msgpack extension implements encode to and decode from the [MessagePack](htt You can either parse into or serialize from a variant-like data structure, [basic_json](../basic_json.md), or your own data structures, using [json_type_traits](../json_type_traits.md). - [decode_msgpack](decode_msgpack.md) [basic_msgpack_cursor](basic_msgpack_cursor.md) diff --git a/doc/ref/ubjson/ubjson.md b/doc/ref/ubjson/ubjson.md index c618c8646e..8135478d65 100644 --- a/doc/ref/ubjson/ubjson.md +++ b/doc/ref/ubjson/ubjson.md @@ -66,7 +66,7 @@ jsoncons allows you to work with the UBJSON data similarly to JSON data: - As a strongly typed C++ data structure that implements [json_type_traits](../json_type_traits.md) -- As a stream of parse events +- With [cursor-level access](doc/ref/ubjson/basic_ubjson_cursor.md) to a stream of parse events #### As a variant-like data structure @@ -145,7 +145,7 @@ Output: 23.8889 ``` -#### As a stream of parse events +#### With cursor-level access ```c++ int main()