From d06a9f8809291595ab04c4db951a87e260831c54 Mon Sep 17 00:00:00 2001 From: Florian Albrechtskirchinger Date: Sat, 23 Jul 2022 19:34:47 +0200 Subject: [PATCH] Add example --- docs/examples/operator_ltlt__json_pointer.cpp | 13 +++++++++++++ docs/examples/operator_ltlt__json_pointer.output | 1 + docs/mkdocs/docs/api/basic_json/operator_ltlt.md | 15 ++++++++++++++- 3 files changed, 28 insertions(+), 1 deletion(-) create mode 100644 docs/examples/operator_ltlt__json_pointer.cpp create mode 100644 docs/examples/operator_ltlt__json_pointer.output diff --git a/docs/examples/operator_ltlt__json_pointer.cpp b/docs/examples/operator_ltlt__json_pointer.cpp new file mode 100644 index 000000000..f4fac886d --- /dev/null +++ b/docs/examples/operator_ltlt__json_pointer.cpp @@ -0,0 +1,13 @@ +#include +#include + +using json = nlohmann::json; + +int main() +{ + // create JSON poiner + json::json_pointer ptr("/foo/bar/baz"); + + // write string representation to stream + std::cout << ptr << std::endl; +} diff --git a/docs/examples/operator_ltlt__json_pointer.output b/docs/examples/operator_ltlt__json_pointer.output new file mode 100644 index 000000000..ed359432d --- /dev/null +++ b/docs/examples/operator_ltlt__json_pointer.output @@ -0,0 +1 @@ +/foo/bar/baz diff --git a/docs/mkdocs/docs/api/basic_json/operator_ltlt.md b/docs/mkdocs/docs/api/basic_json/operator_ltlt.md index 6811ddd1e..7d2aa66fe 100644 --- a/docs/mkdocs/docs/api/basic_json/operator_ltlt.md +++ b/docs/mkdocs/docs/api/basic_json/operator_ltlt.md @@ -55,7 +55,7 @@ Linear. ??? example "Example: (1) serialize JSON value to stream" The example below shows the serialization with different parameters to `width` to adjust the indentation level. - + ```cpp --8<-- "examples/operator_ltlt__basic_json.cpp" ``` @@ -66,6 +66,19 @@ Linear. --8<-- "examples/operator_ltlt__basic_json.output" ``` +??? example "Example: (2) write JSON pointer to stream" + + The example below shows how to write a JSON pointer to a stream. + + ```cpp + --8<-- "examples/operator_ltlt__json_pointer.cpp" + ``` + + Output: + + ```json + --8<-- "examples/operator_ltlt__json_pointer.output" + ``` ## Version history 1. Added in version 1.0.0. Added support for indentation character and deprecated