diff --git a/docs/examples/~basic_json.cpp b/docs/examples/~basic_json.cpp new file mode 100644 index 000000000..ee1adc479 --- /dev/null +++ b/docs/examples/~basic_json.cpp @@ -0,0 +1,13 @@ +#include +#include + +using json = nlohmann::json; + +int main() +{ + json* j = new json("Hello, world!"); + std::cout << *j << std::endl; + + // explicitly call destructor + delete j; +} diff --git a/docs/examples/~basic_json.output b/docs/examples/~basic_json.output new file mode 100644 index 000000000..8effb3e8c --- /dev/null +++ b/docs/examples/~basic_json.output @@ -0,0 +1 @@ +"Hello, world!" diff --git a/docs/mkdocs/docs/api/basic_json/~basic_json.md b/docs/mkdocs/docs/api/basic_json/~basic_json.md index c5c74a525..dc3a7e821 100644 --- a/docs/mkdocs/docs/api/basic_json/~basic_json.md +++ b/docs/mkdocs/docs/api/basic_json/~basic_json.md @@ -14,6 +14,22 @@ No-throw guarantee: this member function never throws exceptions. Linear. +## Examples + +??? example + + The following code shows an example for the destructor. + + ```cpp + --8<-- "examples/~basic_json.cpp" + ``` + + Output: + + ```json + --8<-- "examples/~basic_json.output" + ``` + ## Version history - Added in version 1.0.0.