From e97c93f4510da758be5075342990e15c9dbce541 Mon Sep 17 00:00:00 2001 From: Niels Lohmann Date: Sun, 7 Nov 2021 13:13:37 +0100 Subject: [PATCH] :wrench: add namespaces --- doc/examples/ordered_map.cpp | 43 +++++++++++++++++++ doc/examples/ordered_map.output | 4 ++ doc/examples/std_hash.cpp | 18 ++++++++ doc/examples/std_hash.output | 8 ++++ .../docs/api/adl_serializer/from_json.md | 2 +- doc/mkdocs/docs/api/adl_serializer/index.md | 2 +- doc/mkdocs/docs/api/adl_serializer/to_json.md | 2 +- doc/mkdocs/docs/api/basic_json/accept.md | 7 ++- doc/mkdocs/docs/api/basic_json/array.md | 2 +- doc/mkdocs/docs/api/basic_json/array_t.md | 2 +- doc/mkdocs/docs/api/basic_json/at.md | 2 +- doc/mkdocs/docs/api/basic_json/back.md | 2 +- doc/mkdocs/docs/api/basic_json/basic_json.md | 2 +- doc/mkdocs/docs/api/basic_json/begin.md | 2 +- doc/mkdocs/docs/api/basic_json/binary.md | 2 +- doc/mkdocs/docs/api/basic_json/binary_t.md | 2 +- doc/mkdocs/docs/api/basic_json/boolean_t.md | 2 +- doc/mkdocs/docs/api/basic_json/cbegin.md | 2 +- .../docs/api/basic_json/cbor_tag_handler_t.md | 2 +- doc/mkdocs/docs/api/basic_json/cend.md | 2 +- doc/mkdocs/docs/api/basic_json/clear.md | 2 +- doc/mkdocs/docs/api/basic_json/contains.md | 2 +- doc/mkdocs/docs/api/basic_json/count.md | 2 +- doc/mkdocs/docs/api/basic_json/crbegin.md | 2 +- doc/mkdocs/docs/api/basic_json/crend.md | 2 +- doc/mkdocs/docs/api/basic_json/diff.md | 2 +- doc/mkdocs/docs/api/basic_json/dump.md | 2 +- doc/mkdocs/docs/api/basic_json/emplace.md | 2 +- .../docs/api/basic_json/emplace_back.md | 2 +- doc/mkdocs/docs/api/basic_json/empty.md | 2 +- doc/mkdocs/docs/api/basic_json/end.md | 2 +- doc/mkdocs/docs/api/basic_json/erase.md | 2 +- .../docs/api/basic_json/error_handler_t.md | 2 +- doc/mkdocs/docs/api/basic_json/exception.md | 2 +- doc/mkdocs/docs/api/basic_json/find.md | 2 +- doc/mkdocs/docs/api/basic_json/flatten.md | 2 +- doc/mkdocs/docs/api/basic_json/from_bson.md | 2 +- doc/mkdocs/docs/api/basic_json/from_cbor.md | 2 +- .../docs/api/basic_json/from_msgpack.md | 2 +- doc/mkdocs/docs/api/basic_json/from_ubjson.md | 2 +- doc/mkdocs/docs/api/basic_json/front.md | 2 +- doc/mkdocs/docs/api/basic_json/get.md | 2 +- .../docs/api/basic_json/get_allocator.md | 2 +- doc/mkdocs/docs/api/basic_json/get_binary.md | 2 +- doc/mkdocs/docs/api/basic_json/get_ptr.md | 2 +- doc/mkdocs/docs/api/basic_json/get_ref.md | 2 +- doc/mkdocs/docs/api/basic_json/get_to.md | 2 +- doc/mkdocs/docs/api/basic_json/index.md | 4 +- .../docs/api/basic_json/input_format_t.md | 2 +- doc/mkdocs/docs/api/basic_json/insert.md | 2 +- .../docs/api/basic_json/invalid_iterator.md | 2 +- doc/mkdocs/docs/api/basic_json/is_array.md | 2 +- doc/mkdocs/docs/api/basic_json/is_binary.md | 2 +- doc/mkdocs/docs/api/basic_json/is_boolean.md | 2 +- .../docs/api/basic_json/is_discarded.md | 2 +- doc/mkdocs/docs/api/basic_json/is_null.md | 2 +- doc/mkdocs/docs/api/basic_json/is_number.md | 2 +- .../docs/api/basic_json/is_number_float.md | 2 +- .../docs/api/basic_json/is_number_integer.md | 2 +- .../docs/api/basic_json/is_number_unsigned.md | 2 +- doc/mkdocs/docs/api/basic_json/is_object.md | 2 +- .../docs/api/basic_json/is_primitive.md | 2 +- doc/mkdocs/docs/api/basic_json/is_string.md | 2 +- .../docs/api/basic_json/is_structured.md | 2 +- doc/mkdocs/docs/api/basic_json/items.md | 2 +- .../docs/api/basic_json/json_serializer.md | 2 +- doc/mkdocs/docs/api/basic_json/max_size.md | 2 +- doc/mkdocs/docs/api/basic_json/merge_patch.md | 2 +- doc/mkdocs/docs/api/basic_json/meta.md | 2 +- .../docs/api/basic_json/number_float_t.md | 2 +- .../docs/api/basic_json/number_integer_t.md | 2 +- .../docs/api/basic_json/number_unsigned_t.md | 2 +- doc/mkdocs/docs/api/basic_json/object.md | 2 +- .../api/basic_json/object_comparator_t.md | 2 +- doc/mkdocs/docs/api/basic_json/object_t.md | 2 +- doc/mkdocs/docs/api/basic_json/operator+=.md | 2 +- doc/mkdocs/docs/api/basic_json/operator=.md | 2 +- doc/mkdocs/docs/api/basic_json/operator[].md | 2 +- .../docs/api/basic_json/operator_ValueType.md | 2 +- doc/mkdocs/docs/api/basic_json/operator_eq.md | 2 +- doc/mkdocs/docs/api/basic_json/operator_ge.md | 2 +- doc/mkdocs/docs/api/basic_json/operator_gt.md | 2 +- .../docs/api/basic_json/operator_gtgt.md | 3 +- doc/mkdocs/docs/api/basic_json/operator_le.md | 2 +- .../api/basic_json/operator_literal_json.md | 2 +- .../operator_literal_json_pointer.md | 2 +- doc/mkdocs/docs/api/basic_json/operator_lt.md | 2 +- doc/mkdocs/docs/api/basic_json/operator_ne.md | 2 +- .../docs/api/basic_json/operator_value_t.md | 2 +- doc/mkdocs/docs/api/basic_json/other_error.md | 2 +- .../docs/api/basic_json/out_of_range.md | 2 +- doc/mkdocs/docs/api/basic_json/parse.md | 7 ++- doc/mkdocs/docs/api/basic_json/parse_error.md | 2 +- .../docs/api/basic_json/parse_event_t.md | 2 +- .../docs/api/basic_json/parser_callback_t.md | 2 +- doc/mkdocs/docs/api/basic_json/patch.md | 2 +- doc/mkdocs/docs/api/basic_json/push_back.md | 2 +- doc/mkdocs/docs/api/basic_json/rbegin.md | 2 +- doc/mkdocs/docs/api/basic_json/rend.md | 2 +- doc/mkdocs/docs/api/basic_json/sax_parse.md | 2 +- doc/mkdocs/docs/api/basic_json/size.md | 2 +- doc/mkdocs/docs/api/basic_json/std_hash.md | 18 +++++++- doc/mkdocs/docs/api/basic_json/string_t.md | 2 +- doc/mkdocs/docs/api/basic_json/swap.md | 2 +- doc/mkdocs/docs/api/basic_json/to_bson.md | 2 +- doc/mkdocs/docs/api/basic_json/to_cbor.md | 2 +- doc/mkdocs/docs/api/basic_json/to_msgpack.md | 2 +- doc/mkdocs/docs/api/basic_json/to_ubjson.md | 2 +- doc/mkdocs/docs/api/basic_json/type.md | 2 +- doc/mkdocs/docs/api/basic_json/type_error.md | 2 +- doc/mkdocs/docs/api/basic_json/type_name.md | 2 +- doc/mkdocs/docs/api/basic_json/unflatten.md | 2 +- doc/mkdocs/docs/api/basic_json/update.md | 2 +- doc/mkdocs/docs/api/basic_json/value.md | 2 +- doc/mkdocs/docs/api/basic_json/value_t.md | 2 +- doc/mkdocs/docs/api/basic_json/~basic_json.md | 2 +- .../byte_container_with_subtype.md | 2 +- .../clear_subtype.md | 2 +- .../has_subtype.md | 2 +- .../api/byte_container_with_subtype/index.md | 2 +- .../set_subtype.md | 2 +- .../byte_container_with_subtype/subtype.md | 2 +- doc/mkdocs/docs/api/json.md | 2 +- doc/mkdocs/docs/api/json_pointer/back.md | 2 +- doc/mkdocs/docs/api/json_pointer/empty.md | 2 +- doc/mkdocs/docs/api/json_pointer/index.md | 2 +- .../docs/api/json_pointer/json_pointer.md | 2 +- .../docs/api/json_pointer/operator_slash.md | 2 +- .../docs/api/json_pointer/operator_slasheq.md | 2 +- .../docs/api/json_pointer/operator_string.md | 2 +- .../docs/api/json_pointer/parent_pointer.md | 2 +- doc/mkdocs/docs/api/json_pointer/pop_back.md | 2 +- doc/mkdocs/docs/api/json_pointer/push_back.md | 2 +- doc/mkdocs/docs/api/json_pointer/to_string.md | 2 +- doc/mkdocs/docs/api/json_sax/binary.md | 2 +- doc/mkdocs/docs/api/json_sax/boolean.md | 2 +- doc/mkdocs/docs/api/json_sax/end_array.md | 2 +- doc/mkdocs/docs/api/json_sax/end_object.md | 2 +- doc/mkdocs/docs/api/json_sax/index.md | 2 +- doc/mkdocs/docs/api/json_sax/key.md | 2 +- doc/mkdocs/docs/api/json_sax/null.md | 2 +- doc/mkdocs/docs/api/json_sax/number_float.md | 2 +- .../docs/api/json_sax/number_integer.md | 2 +- .../docs/api/json_sax/number_unsigned.md | 2 +- doc/mkdocs/docs/api/json_sax/parse_error.md | 2 +- doc/mkdocs/docs/api/json_sax/start_array.md | 2 +- doc/mkdocs/docs/api/json_sax/start_object.md | 2 +- doc/mkdocs/docs/api/json_sax/string.md | 2 +- doc/mkdocs/docs/api/ordered_json.md | 4 +- doc/mkdocs/docs/api/ordered_map.md | 27 ++++++++++-- doc/mkdocs/mkdocs.yml | 6 +-- doc/mkdocs/scripts/check_structure.py | 1 + 152 files changed, 275 insertions(+), 153 deletions(-) create mode 100644 doc/examples/ordered_map.cpp create mode 100644 doc/examples/ordered_map.output create mode 100644 doc/examples/std_hash.cpp create mode 100644 doc/examples/std_hash.output diff --git a/doc/examples/ordered_map.cpp b/doc/examples/ordered_map.cpp new file mode 100644 index 000000000..dcc60cb52 --- /dev/null +++ b/doc/examples/ordered_map.cpp @@ -0,0 +1,43 @@ +#include +#include + +// simple output function +template +void output(const char* prefix, const Map& m) +{ + std::cout << prefix << " = { "; + for (auto& element : m) + { + std::cout << element.first << ":" << element.second << ' '; + } + std::cout << "}" << std::endl; +} + +int main() +{ + // create and fill two maps + nlohmann::ordered_map m_ordered; + m_ordered["one"] = "eins"; + m_ordered["two"] = "zwei"; + m_ordered["three"] = "drei"; + + std::map m_std; + m_std["one"] = "eins"; + m_std["two"] = "zwei"; + m_std["three"] = "drei"; + + // output: m_ordered is ordered by insertion order, m_std is ordered by key + output("m_ordered", m_ordered); + output("m_std", m_std); + + // erase and re-add "one" key + m_ordered.erase("one"); + m_ordered["one"] = "eins"; + + m_std.erase("one"); + m_std["one"] = "eins"; + + // output: m_ordered shows newly added key at the end; m_std is again ordered by key + output("m_ordered", m_ordered); + output("m_std", m_std); +} diff --git a/doc/examples/ordered_map.output b/doc/examples/ordered_map.output new file mode 100644 index 000000000..a4ffc454a --- /dev/null +++ b/doc/examples/ordered_map.output @@ -0,0 +1,4 @@ +m_ordered = { one:eins two:zwei three:drei } +m_std = { one:eins three:drei two:zwei } +m_ordered = { two:zwei three:drei one:eins } +m_std = { one:eins three:drei two:zwei } diff --git a/doc/examples/std_hash.cpp b/doc/examples/std_hash.cpp new file mode 100644 index 000000000..eee0fad0c --- /dev/null +++ b/doc/examples/std_hash.cpp @@ -0,0 +1,18 @@ +#include +#include +#include + +using json = nlohmann::json; + +int main() +{ + std::cout << "hash(null) = " << std::hash {}(json(nullptr)) << '\n' + << "hash(false) = " << std::hash {}(json(false)) << '\n' + << "hash(0) = " << std::hash {}(json(0)) << '\n' + << "hash(0U) = " << std::hash {}(json(0U)) << '\n' + << "hash(\"\") = " << std::hash {}(json("")) << '\n' + << "hash({}) = " << std::hash {}(json::object()) << '\n' + << "hash([]) = " << std::hash {}(json::array()) << '\n' + << "hash({\"hello\": \"world\"}) = " << std::hash {}("{\"hello\": \"world\"}"_json) + << std::endl; +} diff --git a/doc/examples/std_hash.output b/doc/examples/std_hash.output new file mode 100644 index 000000000..d1b1b48b7 --- /dev/null +++ b/doc/examples/std_hash.output @@ -0,0 +1,8 @@ +hash(null) = 2654435769 +hash(false) = 2654436030 +hash(0) = 2654436095 +hash(0U) = 2654436156 +hash("") = 11160318156688833227 +hash({}) = 2654435832 +hash([]) = 2654435899 +hash({"hello": "world"}) = 3701319991624763853 diff --git a/doc/mkdocs/docs/api/adl_serializer/from_json.md b/doc/mkdocs/docs/api/adl_serializer/from_json.md index 0524c82ce..7657855a3 100644 --- a/doc/mkdocs/docs/api/adl_serializer/from_json.md +++ b/doc/mkdocs/docs/api/adl_serializer/from_json.md @@ -1,4 +1,4 @@ -# adl_serializer::from_json +# nlohmann::adl_serializer::from_json ```cpp // (1) diff --git a/doc/mkdocs/docs/api/adl_serializer/index.md b/doc/mkdocs/docs/api/adl_serializer/index.md index 784ab5da6..95f35cddf 100644 --- a/doc/mkdocs/docs/api/adl_serializer/index.md +++ b/doc/mkdocs/docs/api/adl_serializer/index.md @@ -1,4 +1,4 @@ -# adl_serializer +# nlohmann::adl_serializer ```cpp template diff --git a/doc/mkdocs/docs/api/adl_serializer/to_json.md b/doc/mkdocs/docs/api/adl_serializer/to_json.md index 37aff5c1a..d39f72525 100644 --- a/doc/mkdocs/docs/api/adl_serializer/to_json.md +++ b/doc/mkdocs/docs/api/adl_serializer/to_json.md @@ -1,4 +1,4 @@ -# adl_serializer::to_json +# nlohmann::adl_serializer::to_json ```cpp template diff --git a/doc/mkdocs/docs/api/basic_json/accept.md b/doc/mkdocs/docs/api/basic_json/accept.md index bd49e6631..f22de9db3 100644 --- a/doc/mkdocs/docs/api/basic_json/accept.md +++ b/doc/mkdocs/docs/api/basic_json/accept.md @@ -1,4 +1,4 @@ -# basic_json::accept +# nlohmann::basic_json::accept ```cpp // (1) @@ -84,6 +84,11 @@ Linear in the length of the input. The parser is a predictive LL(1) parser. --8<-- "examples/accept__string.output" ``` +## See also + +- [parse](parse.md) - deserialize from a compatible input +- [operator>>](operator_gtgt.md) - deserialize from stream + ## Version history - Added in version 3.0.0. diff --git a/doc/mkdocs/docs/api/basic_json/array.md b/doc/mkdocs/docs/api/basic_json/array.md index 680637b34..22b2ee1db 100644 --- a/doc/mkdocs/docs/api/basic_json/array.md +++ b/doc/mkdocs/docs/api/basic_json/array.md @@ -1,4 +1,4 @@ -# basic_json::array +# nlohmann::basic_json::array ```cpp static basic_json array(initializer_list_t init = {}); diff --git a/doc/mkdocs/docs/api/basic_json/array_t.md b/doc/mkdocs/docs/api/basic_json/array_t.md index f84e645bc..dc81d730f 100644 --- a/doc/mkdocs/docs/api/basic_json/array_t.md +++ b/doc/mkdocs/docs/api/basic_json/array_t.md @@ -1,4 +1,4 @@ -# basic_json::array_t +# nlohmann::basic_json::array_t ```cpp using array_t = ArrayType>; diff --git a/doc/mkdocs/docs/api/basic_json/at.md b/doc/mkdocs/docs/api/basic_json/at.md index 9f5023313..1ad661322 100644 --- a/doc/mkdocs/docs/api/basic_json/at.md +++ b/doc/mkdocs/docs/api/basic_json/at.md @@ -1,4 +1,4 @@ -# basic_json::at +# nlohmann::basic_json::at ```cpp // (1) diff --git a/doc/mkdocs/docs/api/basic_json/back.md b/doc/mkdocs/docs/api/basic_json/back.md index a66b2d73e..96e1dec75 100644 --- a/doc/mkdocs/docs/api/basic_json/back.md +++ b/doc/mkdocs/docs/api/basic_json/back.md @@ -1,4 +1,4 @@ -# basic_json::back +# nlohmann::basic_json::back ```cpp reference back(); diff --git a/doc/mkdocs/docs/api/basic_json/basic_json.md b/doc/mkdocs/docs/api/basic_json/basic_json.md index bbed0e4ed..27d6ee821 100644 --- a/doc/mkdocs/docs/api/basic_json/basic_json.md +++ b/doc/mkdocs/docs/api/basic_json/basic_json.md @@ -1,4 +1,4 @@ -# basic_json::basic_json +# nlohmann::basic_json::basic_json ```cpp // (1) diff --git a/doc/mkdocs/docs/api/basic_json/begin.md b/doc/mkdocs/docs/api/basic_json/begin.md index a1de9d4d0..ef623a5ff 100644 --- a/doc/mkdocs/docs/api/basic_json/begin.md +++ b/doc/mkdocs/docs/api/basic_json/begin.md @@ -1,4 +1,4 @@ -# basic_json::begin +# nlohmann::basic_json::begin ```cpp iterator begin() noexcept; diff --git a/doc/mkdocs/docs/api/basic_json/binary.md b/doc/mkdocs/docs/api/basic_json/binary.md index 0b1b9f48b..059500e23 100644 --- a/doc/mkdocs/docs/api/basic_json/binary.md +++ b/doc/mkdocs/docs/api/basic_json/binary.md @@ -1,4 +1,4 @@ -# basic_json::binary +# nlohmann::basic_json::binary ```cpp // (1) diff --git a/doc/mkdocs/docs/api/basic_json/binary_t.md b/doc/mkdocs/docs/api/basic_json/binary_t.md index 1879fb0d2..631537aa9 100644 --- a/doc/mkdocs/docs/api/basic_json/binary_t.md +++ b/doc/mkdocs/docs/api/basic_json/binary_t.md @@ -1,4 +1,4 @@ -# basic_json::binary_t +# nlohmann::basic_json::binary_t ```cpp using binary_t = byte_container_with_subtype; diff --git a/doc/mkdocs/docs/api/basic_json/boolean_t.md b/doc/mkdocs/docs/api/basic_json/boolean_t.md index a61151410..b0fb1872c 100644 --- a/doc/mkdocs/docs/api/basic_json/boolean_t.md +++ b/doc/mkdocs/docs/api/basic_json/boolean_t.md @@ -1,4 +1,4 @@ -# basic_json::boolean_t +# nlohmann::basic_json::boolean_t ```cpp using boolean_t = BooleanType; diff --git a/doc/mkdocs/docs/api/basic_json/cbegin.md b/doc/mkdocs/docs/api/basic_json/cbegin.md index 68a881443..06504fee6 100644 --- a/doc/mkdocs/docs/api/basic_json/cbegin.md +++ b/doc/mkdocs/docs/api/basic_json/cbegin.md @@ -1,4 +1,4 @@ -# basic_json::cbegin +# nlohmann::basic_json::cbegin ```cpp const_iterator cbegin() const noexcept; diff --git a/doc/mkdocs/docs/api/basic_json/cbor_tag_handler_t.md b/doc/mkdocs/docs/api/basic_json/cbor_tag_handler_t.md index 7073b9d7d..6622d8aca 100644 --- a/doc/mkdocs/docs/api/basic_json/cbor_tag_handler_t.md +++ b/doc/mkdocs/docs/api/basic_json/cbor_tag_handler_t.md @@ -1,4 +1,4 @@ -# basic_json::cbor_tag_handler_t +# nlohmann::basic_json::cbor_tag_handler_t ```cpp enum class cbor_tag_handler_t diff --git a/doc/mkdocs/docs/api/basic_json/cend.md b/doc/mkdocs/docs/api/basic_json/cend.md index 3786e1df2..3f3aa949d 100644 --- a/doc/mkdocs/docs/api/basic_json/cend.md +++ b/doc/mkdocs/docs/api/basic_json/cend.md @@ -1,4 +1,4 @@ -# basic_json::cend +# nlohmann::basic_json::cend ```cpp const_iterator cend() const noexcept; diff --git a/doc/mkdocs/docs/api/basic_json/clear.md b/doc/mkdocs/docs/api/basic_json/clear.md index c34439ef2..00367c838 100644 --- a/doc/mkdocs/docs/api/basic_json/clear.md +++ b/doc/mkdocs/docs/api/basic_json/clear.md @@ -1,4 +1,4 @@ -# basic_json::clear +# nlohmann::basic_json::clear ```cpp void clear() noexcept; diff --git a/doc/mkdocs/docs/api/basic_json/contains.md b/doc/mkdocs/docs/api/basic_json/contains.md index f49c73a8f..8463f4ea9 100644 --- a/doc/mkdocs/docs/api/basic_json/contains.md +++ b/doc/mkdocs/docs/api/basic_json/contains.md @@ -1,4 +1,4 @@ -# basic_json::contains +# nlohmann::basic_json::contains ```cpp // (1) diff --git a/doc/mkdocs/docs/api/basic_json/count.md b/doc/mkdocs/docs/api/basic_json/count.md index 5ed627bf1..fcfef8673 100644 --- a/doc/mkdocs/docs/api/basic_json/count.md +++ b/doc/mkdocs/docs/api/basic_json/count.md @@ -1,4 +1,4 @@ -# basic_json::count +# nlohmann::basic_json::count ```cpp template diff --git a/doc/mkdocs/docs/api/basic_json/crbegin.md b/doc/mkdocs/docs/api/basic_json/crbegin.md index 5b2f6101c..7af5ecae4 100644 --- a/doc/mkdocs/docs/api/basic_json/crbegin.md +++ b/doc/mkdocs/docs/api/basic_json/crbegin.md @@ -1,4 +1,4 @@ -# basic_json::crbegin +# nlohmann::basic_json::crbegin ```cpp const_reverse_iterator crbegin() const noexcept; diff --git a/doc/mkdocs/docs/api/basic_json/crend.md b/doc/mkdocs/docs/api/basic_json/crend.md index 82375890f..0e6bc8474 100644 --- a/doc/mkdocs/docs/api/basic_json/crend.md +++ b/doc/mkdocs/docs/api/basic_json/crend.md @@ -1,4 +1,4 @@ -# basic_json::crend +# nlohmann::basic_json::crend ```cpp const_reverse_iterator crend() const noexcept; diff --git a/doc/mkdocs/docs/api/basic_json/diff.md b/doc/mkdocs/docs/api/basic_json/diff.md index 6f68b25a9..4e840684e 100644 --- a/doc/mkdocs/docs/api/basic_json/diff.md +++ b/doc/mkdocs/docs/api/basic_json/diff.md @@ -1,4 +1,4 @@ -# basic_json::diff +# nlohmann::basic_json::diff ```cpp static basic_json diff(const basic_json& source, diff --git a/doc/mkdocs/docs/api/basic_json/dump.md b/doc/mkdocs/docs/api/basic_json/dump.md index 21fd33014..41adb154d 100644 --- a/doc/mkdocs/docs/api/basic_json/dump.md +++ b/doc/mkdocs/docs/api/basic_json/dump.md @@ -1,4 +1,4 @@ -# basic_json::dump +# nlohmann::basic_json::dump ```cpp string_t dump(const int indent = -1, diff --git a/doc/mkdocs/docs/api/basic_json/emplace.md b/doc/mkdocs/docs/api/basic_json/emplace.md index 50a9c92e3..6cc2c98d7 100644 --- a/doc/mkdocs/docs/api/basic_json/emplace.md +++ b/doc/mkdocs/docs/api/basic_json/emplace.md @@ -1,4 +1,4 @@ -# basic_json::emplace +# nlohmann::basic_json::emplace ```cpp template diff --git a/doc/mkdocs/docs/api/basic_json/emplace_back.md b/doc/mkdocs/docs/api/basic_json/emplace_back.md index 8a8af0c66..597ad41e4 100644 --- a/doc/mkdocs/docs/api/basic_json/emplace_back.md +++ b/doc/mkdocs/docs/api/basic_json/emplace_back.md @@ -1,4 +1,4 @@ -# basic_json::emplace_back +# nlohmann::basic_json::emplace_back ```cpp template diff --git a/doc/mkdocs/docs/api/basic_json/empty.md b/doc/mkdocs/docs/api/basic_json/empty.md index 41d4f4996..e914e1689 100644 --- a/doc/mkdocs/docs/api/basic_json/empty.md +++ b/doc/mkdocs/docs/api/basic_json/empty.md @@ -1,4 +1,4 @@ -# basic_json::empty +# nlohmann::basic_json::empty ```cpp bool empty() const noexcept; diff --git a/doc/mkdocs/docs/api/basic_json/end.md b/doc/mkdocs/docs/api/basic_json/end.md index d6948a726..179ce9e67 100644 --- a/doc/mkdocs/docs/api/basic_json/end.md +++ b/doc/mkdocs/docs/api/basic_json/end.md @@ -1,4 +1,4 @@ -# basic_json::end +# nlohmann::basic_json::end ```cpp iterator end() noexcept; diff --git a/doc/mkdocs/docs/api/basic_json/erase.md b/doc/mkdocs/docs/api/basic_json/erase.md index fd83635a0..a9aa28ae1 100644 --- a/doc/mkdocs/docs/api/basic_json/erase.md +++ b/doc/mkdocs/docs/api/basic_json/erase.md @@ -1,4 +1,4 @@ -# basic_json::erase +# nlohmann::basic_json::erase ```cpp // (1) diff --git a/doc/mkdocs/docs/api/basic_json/error_handler_t.md b/doc/mkdocs/docs/api/basic_json/error_handler_t.md index 050dda14d..afd20f89d 100644 --- a/doc/mkdocs/docs/api/basic_json/error_handler_t.md +++ b/doc/mkdocs/docs/api/basic_json/error_handler_t.md @@ -1,4 +1,4 @@ -# basic_json::error_handler_t +# nlohmann::basic_json::error_handler_t ```cpp enum class error_handler_t { diff --git a/doc/mkdocs/docs/api/basic_json/exception.md b/doc/mkdocs/docs/api/basic_json/exception.md index 2b471858a..b492666d8 100644 --- a/doc/mkdocs/docs/api/basic_json/exception.md +++ b/doc/mkdocs/docs/api/basic_json/exception.md @@ -1,4 +1,4 @@ -# basic_json::exception +# nlohmann::basic_json::exception ```cpp class exception : public std::exception; diff --git a/doc/mkdocs/docs/api/basic_json/find.md b/doc/mkdocs/docs/api/basic_json/find.md index 6c233b280..af4cb2972 100644 --- a/doc/mkdocs/docs/api/basic_json/find.md +++ b/doc/mkdocs/docs/api/basic_json/find.md @@ -1,4 +1,4 @@ -# basic_json::find +# nlohmann::basic_json::find ```cpp template diff --git a/doc/mkdocs/docs/api/basic_json/flatten.md b/doc/mkdocs/docs/api/basic_json/flatten.md index 0c6f640cb..8703e86d1 100644 --- a/doc/mkdocs/docs/api/basic_json/flatten.md +++ b/doc/mkdocs/docs/api/basic_json/flatten.md @@ -1,4 +1,4 @@ -# basic_json::flatten +# nlohmann::basic_json::flatten ```cpp basic_json flatten() const; diff --git a/doc/mkdocs/docs/api/basic_json/from_bson.md b/doc/mkdocs/docs/api/basic_json/from_bson.md index 968a33547..747e2e4fd 100644 --- a/doc/mkdocs/docs/api/basic_json/from_bson.md +++ b/doc/mkdocs/docs/api/basic_json/from_bson.md @@ -1,4 +1,4 @@ -# basic_json::from_bson +# nlohmann::basic_json::from_bson ```cpp // (1) diff --git a/doc/mkdocs/docs/api/basic_json/from_cbor.md b/doc/mkdocs/docs/api/basic_json/from_cbor.md index 6e8bff60f..06d74cab8 100644 --- a/doc/mkdocs/docs/api/basic_json/from_cbor.md +++ b/doc/mkdocs/docs/api/basic_json/from_cbor.md @@ -1,4 +1,4 @@ -# basic_json::from_cbor +# nlohmann::basic_json::from_cbor ```cpp // (1) diff --git a/doc/mkdocs/docs/api/basic_json/from_msgpack.md b/doc/mkdocs/docs/api/basic_json/from_msgpack.md index cf191ec63..7665f8f9f 100644 --- a/doc/mkdocs/docs/api/basic_json/from_msgpack.md +++ b/doc/mkdocs/docs/api/basic_json/from_msgpack.md @@ -1,4 +1,4 @@ -# basic_json::from_msgpack +# nlohmann::basic_json::from_msgpack ```cpp // (1) diff --git a/doc/mkdocs/docs/api/basic_json/from_ubjson.md b/doc/mkdocs/docs/api/basic_json/from_ubjson.md index 6ab8df66f..7ced89ea0 100644 --- a/doc/mkdocs/docs/api/basic_json/from_ubjson.md +++ b/doc/mkdocs/docs/api/basic_json/from_ubjson.md @@ -1,4 +1,4 @@ -# basic_json::from_ubjson +# nlohmann::basic_json::from_ubjson ```cpp // (1) diff --git a/doc/mkdocs/docs/api/basic_json/front.md b/doc/mkdocs/docs/api/basic_json/front.md index 33b617014..909f0b59b 100644 --- a/doc/mkdocs/docs/api/basic_json/front.md +++ b/doc/mkdocs/docs/api/basic_json/front.md @@ -1,4 +1,4 @@ -# basic_json::front +# nlohmann::basic_json::front ```cpp reference front(); diff --git a/doc/mkdocs/docs/api/basic_json/get.md b/doc/mkdocs/docs/api/basic_json/get.md index 86b8166e5..0a0bc3bab 100644 --- a/doc/mkdocs/docs/api/basic_json/get.md +++ b/doc/mkdocs/docs/api/basic_json/get.md @@ -1,4 +1,4 @@ -# basic_json::get +# nlohmann::basic_json::get ```cpp // (1) diff --git a/doc/mkdocs/docs/api/basic_json/get_allocator.md b/doc/mkdocs/docs/api/basic_json/get_allocator.md index 431c64d65..1b7700c77 100644 --- a/doc/mkdocs/docs/api/basic_json/get_allocator.md +++ b/doc/mkdocs/docs/api/basic_json/get_allocator.md @@ -1,4 +1,4 @@ -# basic_json::get_allocator +# nlohmann::basic_json::get_allocator ```cpp static allocator_type get_allocator(); diff --git a/doc/mkdocs/docs/api/basic_json/get_binary.md b/doc/mkdocs/docs/api/basic_json/get_binary.md index 46d5b652d..b4d601819 100644 --- a/doc/mkdocs/docs/api/basic_json/get_binary.md +++ b/doc/mkdocs/docs/api/basic_json/get_binary.md @@ -1,4 +1,4 @@ -# basic_json::get_binary +# nlohmann::basic_json::get_binary ```cpp binary_t& get_binary(); diff --git a/doc/mkdocs/docs/api/basic_json/get_ptr.md b/doc/mkdocs/docs/api/basic_json/get_ptr.md index f85a73db2..72517cd7e 100644 --- a/doc/mkdocs/docs/api/basic_json/get_ptr.md +++ b/doc/mkdocs/docs/api/basic_json/get_ptr.md @@ -1,4 +1,4 @@ -# basic_json::get_ptr +# nlohmann::basic_json::get_ptr ```cpp template diff --git a/doc/mkdocs/docs/api/basic_json/get_ref.md b/doc/mkdocs/docs/api/basic_json/get_ref.md index a819e24eb..1140836e4 100644 --- a/doc/mkdocs/docs/api/basic_json/get_ref.md +++ b/doc/mkdocs/docs/api/basic_json/get_ref.md @@ -1,4 +1,4 @@ -# basic_json::get_ref +# nlohmann::basic_json::get_ref ```cpp template diff --git a/doc/mkdocs/docs/api/basic_json/get_to.md b/doc/mkdocs/docs/api/basic_json/get_to.md index 2d19b85cb..6af6d212c 100644 --- a/doc/mkdocs/docs/api/basic_json/get_to.md +++ b/doc/mkdocs/docs/api/basic_json/get_to.md @@ -1,4 +1,4 @@ -# basic_json::get_to +# nlohmann::basic_json::get_to ```cpp template diff --git a/doc/mkdocs/docs/api/basic_json/index.md b/doc/mkdocs/docs/api/basic_json/index.md index 2ab8f5fdb..eea970682 100644 --- a/doc/mkdocs/docs/api/basic_json/index.md +++ b/doc/mkdocs/docs/api/basic_json/index.md @@ -1,6 +1,6 @@ -# basic_json +# nlohmann::basic_json -Defined in header `` +Defined in header `` ```cpp template< diff --git a/doc/mkdocs/docs/api/basic_json/input_format_t.md b/doc/mkdocs/docs/api/basic_json/input_format_t.md index 783085d8e..8d8d7e279 100644 --- a/doc/mkdocs/docs/api/basic_json/input_format_t.md +++ b/doc/mkdocs/docs/api/basic_json/input_format_t.md @@ -1,4 +1,4 @@ -# basic_json::input_format_t +# nlohmann::basic_json::input_format_t ```cpp enum class input_format_t { diff --git a/doc/mkdocs/docs/api/basic_json/insert.md b/doc/mkdocs/docs/api/basic_json/insert.md index 821e91907..c6e1d2c1f 100644 --- a/doc/mkdocs/docs/api/basic_json/insert.md +++ b/doc/mkdocs/docs/api/basic_json/insert.md @@ -1,4 +1,4 @@ -# basic_json::insert +# nlohmann::basic_json::insert ```cpp // (1) diff --git a/doc/mkdocs/docs/api/basic_json/invalid_iterator.md b/doc/mkdocs/docs/api/basic_json/invalid_iterator.md index 8d947b5b4..f9fdce5b4 100644 --- a/doc/mkdocs/docs/api/basic_json/invalid_iterator.md +++ b/doc/mkdocs/docs/api/basic_json/invalid_iterator.md @@ -1,4 +1,4 @@ -# basic_json::invalid_iterator +# nlohmann::basic_json::invalid_iterator ```cpp class invalid_iterator : public exception; diff --git a/doc/mkdocs/docs/api/basic_json/is_array.md b/doc/mkdocs/docs/api/basic_json/is_array.md index 42f9c4651..64468c357 100644 --- a/doc/mkdocs/docs/api/basic_json/is_array.md +++ b/doc/mkdocs/docs/api/basic_json/is_array.md @@ -1,4 +1,4 @@ -# basic_json::is_array +# nlohmann::basic_json::is_array ```cpp constexpr bool is_array() const noexcept; diff --git a/doc/mkdocs/docs/api/basic_json/is_binary.md b/doc/mkdocs/docs/api/basic_json/is_binary.md index 6c234d0ee..ea48d745c 100644 --- a/doc/mkdocs/docs/api/basic_json/is_binary.md +++ b/doc/mkdocs/docs/api/basic_json/is_binary.md @@ -1,4 +1,4 @@ -# basic_json::is_binary +# nlohmann::basic_json::is_binary ```cpp constexpr bool is_binary() const noexcept; diff --git a/doc/mkdocs/docs/api/basic_json/is_boolean.md b/doc/mkdocs/docs/api/basic_json/is_boolean.md index 019dd81b6..dc41d84bd 100644 --- a/doc/mkdocs/docs/api/basic_json/is_boolean.md +++ b/doc/mkdocs/docs/api/basic_json/is_boolean.md @@ -1,4 +1,4 @@ -# basic_json::is_boolean +# nlohmann::basic_json::is_boolean ```cpp constexpr bool is_boolean() const noexcept; diff --git a/doc/mkdocs/docs/api/basic_json/is_discarded.md b/doc/mkdocs/docs/api/basic_json/is_discarded.md index c46d215d2..405ae6c11 100644 --- a/doc/mkdocs/docs/api/basic_json/is_discarded.md +++ b/doc/mkdocs/docs/api/basic_json/is_discarded.md @@ -1,4 +1,4 @@ -# basic_json::is_discarded +# nlohmann::basic_json::is_discarded ```cpp constexpr bool is_discarded() const noexcept; diff --git a/doc/mkdocs/docs/api/basic_json/is_null.md b/doc/mkdocs/docs/api/basic_json/is_null.md index 1a03898fe..d080ad32f 100644 --- a/doc/mkdocs/docs/api/basic_json/is_null.md +++ b/doc/mkdocs/docs/api/basic_json/is_null.md @@ -1,4 +1,4 @@ -# basic_json::is_null +# nlohmann::basic_json::is_null ```cpp constexpr bool is_null() const noexcept; diff --git a/doc/mkdocs/docs/api/basic_json/is_number.md b/doc/mkdocs/docs/api/basic_json/is_number.md index eff1751a4..a73859950 100644 --- a/doc/mkdocs/docs/api/basic_json/is_number.md +++ b/doc/mkdocs/docs/api/basic_json/is_number.md @@ -1,4 +1,4 @@ -# basic_json::is_number +# nlohmann::basic_json::is_number ```cpp constexpr bool is_number() const noexcept; diff --git a/doc/mkdocs/docs/api/basic_json/is_number_float.md b/doc/mkdocs/docs/api/basic_json/is_number_float.md index 8380907d8..37bf0fbb9 100644 --- a/doc/mkdocs/docs/api/basic_json/is_number_float.md +++ b/doc/mkdocs/docs/api/basic_json/is_number_float.md @@ -1,4 +1,4 @@ -# basic_json::is_number_float +# nlohmann::basic_json::is_number_float ```cpp constexpr bool is_number_float() const noexcept; diff --git a/doc/mkdocs/docs/api/basic_json/is_number_integer.md b/doc/mkdocs/docs/api/basic_json/is_number_integer.md index 94c1c1a56..2e09bc47e 100644 --- a/doc/mkdocs/docs/api/basic_json/is_number_integer.md +++ b/doc/mkdocs/docs/api/basic_json/is_number_integer.md @@ -1,4 +1,4 @@ -# basic_json::is_number_integer +# nlohmann::basic_json::is_number_integer ```cpp constexpr bool is_number_integer() const noexcept; diff --git a/doc/mkdocs/docs/api/basic_json/is_number_unsigned.md b/doc/mkdocs/docs/api/basic_json/is_number_unsigned.md index 5a56e27c6..84063d238 100644 --- a/doc/mkdocs/docs/api/basic_json/is_number_unsigned.md +++ b/doc/mkdocs/docs/api/basic_json/is_number_unsigned.md @@ -1,4 +1,4 @@ -# basic_json::is_number_unsigned +# nlohmann::basic_json::is_number_unsigned ```cpp constexpr bool is_number_unsigned() const noexcept; diff --git a/doc/mkdocs/docs/api/basic_json/is_object.md b/doc/mkdocs/docs/api/basic_json/is_object.md index bad30f33b..04457013b 100644 --- a/doc/mkdocs/docs/api/basic_json/is_object.md +++ b/doc/mkdocs/docs/api/basic_json/is_object.md @@ -1,4 +1,4 @@ -# basic_json::is_object +# nlohmann::basic_json::is_object ```cpp constexpr bool is_object() const noexcept; diff --git a/doc/mkdocs/docs/api/basic_json/is_primitive.md b/doc/mkdocs/docs/api/basic_json/is_primitive.md index 96f50d5c2..1810f2b06 100644 --- a/doc/mkdocs/docs/api/basic_json/is_primitive.md +++ b/doc/mkdocs/docs/api/basic_json/is_primitive.md @@ -1,4 +1,4 @@ -# basic_json::is_primitive +# nlohmann::basic_json::is_primitive ```cpp constexpr bool is_primitive() const noexcept; diff --git a/doc/mkdocs/docs/api/basic_json/is_string.md b/doc/mkdocs/docs/api/basic_json/is_string.md index 8b91a7f82..b82c92465 100644 --- a/doc/mkdocs/docs/api/basic_json/is_string.md +++ b/doc/mkdocs/docs/api/basic_json/is_string.md @@ -1,4 +1,4 @@ -# basic_json::is_string +# nlohmann::basic_json::is_string ```cpp constexpr bool is_string() const noexcept; diff --git a/doc/mkdocs/docs/api/basic_json/is_structured.md b/doc/mkdocs/docs/api/basic_json/is_structured.md index 50246b73b..b4694163d 100644 --- a/doc/mkdocs/docs/api/basic_json/is_structured.md +++ b/doc/mkdocs/docs/api/basic_json/is_structured.md @@ -1,4 +1,4 @@ -# basic_json::is_structured +# nlohmann::basic_json::is_structured ```cpp constexpr bool is_structured() const noexcept; diff --git a/doc/mkdocs/docs/api/basic_json/items.md b/doc/mkdocs/docs/api/basic_json/items.md index 3d9c6fb78..ade372fff 100644 --- a/doc/mkdocs/docs/api/basic_json/items.md +++ b/doc/mkdocs/docs/api/basic_json/items.md @@ -1,4 +1,4 @@ -# basic_json::items +# nlohmann::basic_json::items ```cpp iteration_proxy items() noexcept; diff --git a/doc/mkdocs/docs/api/basic_json/json_serializer.md b/doc/mkdocs/docs/api/basic_json/json_serializer.md index 7c50284b7..f09115567 100644 --- a/doc/mkdocs/docs/api/basic_json/json_serializer.md +++ b/doc/mkdocs/docs/api/basic_json/json_serializer.md @@ -1,4 +1,4 @@ -# basic_json::json_serializer +# nlohmann::basic_json::json_serializer ```cpp template diff --git a/doc/mkdocs/docs/api/basic_json/max_size.md b/doc/mkdocs/docs/api/basic_json/max_size.md index 7b408f0e7..b07500224 100644 --- a/doc/mkdocs/docs/api/basic_json/max_size.md +++ b/doc/mkdocs/docs/api/basic_json/max_size.md @@ -1,4 +1,4 @@ -# basic_json::max_size +# nlohmann::basic_json::max_size ```cpp size_type max_size() const noexcept; diff --git a/doc/mkdocs/docs/api/basic_json/merge_patch.md b/doc/mkdocs/docs/api/basic_json/merge_patch.md index 12007d448..1718c9227 100644 --- a/doc/mkdocs/docs/api/basic_json/merge_patch.md +++ b/doc/mkdocs/docs/api/basic_json/merge_patch.md @@ -1,4 +1,4 @@ -# basic_json::merge_patch +# nlohmann::basic_json::merge_patch ```cpp void merge_patch(const basic_json& apply_patch); diff --git a/doc/mkdocs/docs/api/basic_json/meta.md b/doc/mkdocs/docs/api/basic_json/meta.md index 78287d21d..6372dd054 100644 --- a/doc/mkdocs/docs/api/basic_json/meta.md +++ b/doc/mkdocs/docs/api/basic_json/meta.md @@ -1,4 +1,4 @@ -# basic_json::meta +# nlohmann::basic_json::meta ```cpp static basic_json meta(); diff --git a/doc/mkdocs/docs/api/basic_json/number_float_t.md b/doc/mkdocs/docs/api/basic_json/number_float_t.md index 0d0182b80..f3e7c3d9d 100644 --- a/doc/mkdocs/docs/api/basic_json/number_float_t.md +++ b/doc/mkdocs/docs/api/basic_json/number_float_t.md @@ -1,4 +1,4 @@ -# basic_json::number_float_t +# nlohmann::basic_json::number_float_t ```cpp using number_float_t = NumberFloatType; diff --git a/doc/mkdocs/docs/api/basic_json/number_integer_t.md b/doc/mkdocs/docs/api/basic_json/number_integer_t.md index c0133f83b..dc8fc0471 100644 --- a/doc/mkdocs/docs/api/basic_json/number_integer_t.md +++ b/doc/mkdocs/docs/api/basic_json/number_integer_t.md @@ -1,4 +1,4 @@ -# basic_json::number_integer_t +# nlohmann::basic_json::number_integer_t ```cpp using number_integer_t = NumberIntegerType; diff --git a/doc/mkdocs/docs/api/basic_json/number_unsigned_t.md b/doc/mkdocs/docs/api/basic_json/number_unsigned_t.md index 49f0e3178..bf8a76d1a 100644 --- a/doc/mkdocs/docs/api/basic_json/number_unsigned_t.md +++ b/doc/mkdocs/docs/api/basic_json/number_unsigned_t.md @@ -1,4 +1,4 @@ -# basic_json::number_unsigned_t +# nlohmann::basic_json::number_unsigned_t ```cpp using number_unsigned_t = NumberUnsignedType; diff --git a/doc/mkdocs/docs/api/basic_json/object.md b/doc/mkdocs/docs/api/basic_json/object.md index c250829cf..9bdbddb6a 100644 --- a/doc/mkdocs/docs/api/basic_json/object.md +++ b/doc/mkdocs/docs/api/basic_json/object.md @@ -1,4 +1,4 @@ -# basic_json::object +# nlohmann::basic_json::object ```cpp static basic_json object(initializer_list_t init = {}); diff --git a/doc/mkdocs/docs/api/basic_json/object_comparator_t.md b/doc/mkdocs/docs/api/basic_json/object_comparator_t.md index 477479619..44509a94b 100644 --- a/doc/mkdocs/docs/api/basic_json/object_comparator_t.md +++ b/doc/mkdocs/docs/api/basic_json/object_comparator_t.md @@ -1,4 +1,4 @@ -# basic_json::object_comparator_t +# nlohmann::basic_json::object_comparator_t ```cpp using object_comparator_t = std::less; // until C++14 diff --git a/doc/mkdocs/docs/api/basic_json/object_t.md b/doc/mkdocs/docs/api/basic_json/object_t.md index e937d847e..89dd4f5cf 100644 --- a/doc/mkdocs/docs/api/basic_json/object_t.md +++ b/doc/mkdocs/docs/api/basic_json/object_t.md @@ -1,4 +1,4 @@ -# basic_json::object_t +# nlohmann::basic_json::object_t ```cpp using object_t = ObjectTypenlohmann::basic_json::operator+= ```cpp // (1) diff --git a/doc/mkdocs/docs/api/basic_json/operator=.md b/doc/mkdocs/docs/api/basic_json/operator=.md index 02e908b4f..4e0b91446 100644 --- a/doc/mkdocs/docs/api/basic_json/operator=.md +++ b/doc/mkdocs/docs/api/basic_json/operator=.md @@ -1,4 +1,4 @@ -# basic_json::operator= +# nlohmann::basic_json::operator= ```cpp basic_json& operator=(basic_json other) noexcept ( diff --git a/doc/mkdocs/docs/api/basic_json/operator[].md b/doc/mkdocs/docs/api/basic_json/operator[].md index f582402ac..5b6512a21 100644 --- a/doc/mkdocs/docs/api/basic_json/operator[].md +++ b/doc/mkdocs/docs/api/basic_json/operator[].md @@ -1,4 +1,4 @@ -# basic_json::operator[] +# nlohmann::basic_json::operator[] ```cpp // (1) diff --git a/doc/mkdocs/docs/api/basic_json/operator_ValueType.md b/doc/mkdocs/docs/api/basic_json/operator_ValueType.md index c35ecac6b..1eec13553 100644 --- a/doc/mkdocs/docs/api/basic_json/operator_ValueType.md +++ b/doc/mkdocs/docs/api/basic_json/operator_ValueType.md @@ -1,4 +1,4 @@ -# basic_json::operator ValueType +# nlohmann::basic_json::operator ValueType ```cpp template diff --git a/doc/mkdocs/docs/api/basic_json/operator_eq.md b/doc/mkdocs/docs/api/basic_json/operator_eq.md index 31fc76b46..027444acd 100644 --- a/doc/mkdocs/docs/api/basic_json/operator_eq.md +++ b/doc/mkdocs/docs/api/basic_json/operator_eq.md @@ -1,4 +1,4 @@ -# basic_json::operator== +# nlohmann::basic_json::operator== ```cpp bool operator==(const_reference lhs, const_reference rhs) noexcept; diff --git a/doc/mkdocs/docs/api/basic_json/operator_ge.md b/doc/mkdocs/docs/api/basic_json/operator_ge.md index 08abbe15e..68aac6557 100644 --- a/doc/mkdocs/docs/api/basic_json/operator_ge.md +++ b/doc/mkdocs/docs/api/basic_json/operator_ge.md @@ -1,4 +1,4 @@ -# basic_json::operator>= +# nlohmann::basic_json::operator>= ```cpp bool operator>=(const_reference lhs, const_reference rhs) noexcept, diff --git a/doc/mkdocs/docs/api/basic_json/operator_gt.md b/doc/mkdocs/docs/api/basic_json/operator_gt.md index b027a165d..92ec30594 100644 --- a/doc/mkdocs/docs/api/basic_json/operator_gt.md +++ b/doc/mkdocs/docs/api/basic_json/operator_gt.md @@ -1,4 +1,4 @@ -# basic_json::operator> +# nlohmann::basic_json::operator> ```cpp bool operator>(const_reference lhs, const_reference rhs) noexcept, diff --git a/doc/mkdocs/docs/api/basic_json/operator_gtgt.md b/doc/mkdocs/docs/api/basic_json/operator_gtgt.md index 879272e62..2f699c92d 100644 --- a/doc/mkdocs/docs/api/basic_json/operator_gtgt.md +++ b/doc/mkdocs/docs/api/basic_json/operator_gtgt.md @@ -51,7 +51,8 @@ A UTF-8 byte order mark is silently ignored. ## See also -- [parse](parse.md) for a variant with a parser callback function to filter values while parsing +- [accept](accept.md) - check if the input is valid JSON +- [parse](parse.md) - deserialize from a compatible input ## Version history diff --git a/doc/mkdocs/docs/api/basic_json/operator_le.md b/doc/mkdocs/docs/api/basic_json/operator_le.md index b4f7be718..54f9a2809 100644 --- a/doc/mkdocs/docs/api/basic_json/operator_le.md +++ b/doc/mkdocs/docs/api/basic_json/operator_le.md @@ -1,4 +1,4 @@ -# basic_json::operator<= +# nlohmann::basic_json::operator<= ```cpp bool operator<=(const_reference lhs, const_reference rhs) noexcept, diff --git a/doc/mkdocs/docs/api/basic_json/operator_literal_json.md b/doc/mkdocs/docs/api/basic_json/operator_literal_json.md index 7db3fb107..b2d3fc5c0 100644 --- a/doc/mkdocs/docs/api/basic_json/operator_literal_json.md +++ b/doc/mkdocs/docs/api/basic_json/operator_literal_json.md @@ -1,4 +1,4 @@ -# basic_json::operator""_json +# nlohmann::basic_json::operator""_json ```cpp json operator "" _json(const char* s, std::size_t n); diff --git a/doc/mkdocs/docs/api/basic_json/operator_literal_json_pointer.md b/doc/mkdocs/docs/api/basic_json/operator_literal_json_pointer.md index 58f95e205..394138441 100644 --- a/doc/mkdocs/docs/api/basic_json/operator_literal_json_pointer.md +++ b/doc/mkdocs/docs/api/basic_json/operator_literal_json_pointer.md @@ -1,4 +1,4 @@ -# basic_json::operator""_json_pointer +# nlohmann::basic_json::operator""_json_pointer ```cpp json_pointer operator "" _json_pointer(const char* s, std::size_t n); diff --git a/doc/mkdocs/docs/api/basic_json/operator_lt.md b/doc/mkdocs/docs/api/basic_json/operator_lt.md index ae9bb6f3f..d1a4999b4 100644 --- a/doc/mkdocs/docs/api/basic_json/operator_lt.md +++ b/doc/mkdocs/docs/api/basic_json/operator_lt.md @@ -1,4 +1,4 @@ -# basic_json::operator< +# nlohmann::basic_json::operator< ```cpp bool operator<(const_reference lhs, const_reference rhs) noexcept; diff --git a/doc/mkdocs/docs/api/basic_json/operator_ne.md b/doc/mkdocs/docs/api/basic_json/operator_ne.md index a9bb109d5..477d40ffc 100644 --- a/doc/mkdocs/docs/api/basic_json/operator_ne.md +++ b/doc/mkdocs/docs/api/basic_json/operator_ne.md @@ -1,4 +1,4 @@ -# basic_json::operator!= +# nlohmann::basic_json::operator!= ```cpp bool operator!=(const_reference lhs, const_reference rhs) noexcept; diff --git a/doc/mkdocs/docs/api/basic_json/operator_value_t.md b/doc/mkdocs/docs/api/basic_json/operator_value_t.md index a89aa8b19..470effc92 100644 --- a/doc/mkdocs/docs/api/basic_json/operator_value_t.md +++ b/doc/mkdocs/docs/api/basic_json/operator_value_t.md @@ -1,4 +1,4 @@ -# basic_json::operator value_t +# nlohmann::basic_json::operator value_t ```cpp constexpr operator value_t() const noexcept; diff --git a/doc/mkdocs/docs/api/basic_json/other_error.md b/doc/mkdocs/docs/api/basic_json/other_error.md index d3bad2f5a..9a83340a0 100644 --- a/doc/mkdocs/docs/api/basic_json/other_error.md +++ b/doc/mkdocs/docs/api/basic_json/other_error.md @@ -1,4 +1,4 @@ -# basic_json::other_error +# nlohmann::basic_json::other_error ```cpp class other_error : public exception; diff --git a/doc/mkdocs/docs/api/basic_json/out_of_range.md b/doc/mkdocs/docs/api/basic_json/out_of_range.md index 67bda325c..6c1f0dfba 100644 --- a/doc/mkdocs/docs/api/basic_json/out_of_range.md +++ b/doc/mkdocs/docs/api/basic_json/out_of_range.md @@ -1,4 +1,4 @@ -# basic_json::out_of_range +# nlohmann::basic_json::out_of_range ```cpp class out_of_range : public exception; diff --git a/doc/mkdocs/docs/api/basic_json/parse.md b/doc/mkdocs/docs/api/basic_json/parse.md index 88d3f93a7..52f96b12d 100644 --- a/doc/mkdocs/docs/api/basic_json/parse.md +++ b/doc/mkdocs/docs/api/basic_json/parse.md @@ -1,4 +1,4 @@ -# basic_json::parse +# nlohmann::basic_json::parse ```cpp // (1) @@ -180,6 +180,11 @@ super-linear complexity. --8<-- "examples/parse__allow_exceptions.output" ``` +## See also + +- [accept](accept.md) - check if the input is valid JSON +- [operator>>](operator_gtgt.md) - deserialize from stream + ## Version history - Added in version 1.0.0. diff --git a/doc/mkdocs/docs/api/basic_json/parse_error.md b/doc/mkdocs/docs/api/basic_json/parse_error.md index 8c860c95e..af3e1f0b3 100644 --- a/doc/mkdocs/docs/api/basic_json/parse_error.md +++ b/doc/mkdocs/docs/api/basic_json/parse_error.md @@ -1,4 +1,4 @@ -# basic_json::parse_error +# nlohmann::basic_json::parse_error ```cpp class parse_error : public exception; diff --git a/doc/mkdocs/docs/api/basic_json/parse_event_t.md b/doc/mkdocs/docs/api/basic_json/parse_event_t.md index d6917127b..1a7c39038 100644 --- a/doc/mkdocs/docs/api/basic_json/parse_event_t.md +++ b/doc/mkdocs/docs/api/basic_json/parse_event_t.md @@ -1,4 +1,4 @@ -# basic_json::parse_event_t +# nlohmann::basic_json::parse_event_t ```cpp enum class parse_event_t : std::uint8_t { diff --git a/doc/mkdocs/docs/api/basic_json/parser_callback_t.md b/doc/mkdocs/docs/api/basic_json/parser_callback_t.md index aeb7c2706..6997cbf79 100644 --- a/doc/mkdocs/docs/api/basic_json/parser_callback_t.md +++ b/doc/mkdocs/docs/api/basic_json/parser_callback_t.md @@ -1,4 +1,4 @@ -# basic_json::parser_callback_t +# nlohmann::basic_json::parser_callback_t ```cpp template diff --git a/doc/mkdocs/docs/api/basic_json/patch.md b/doc/mkdocs/docs/api/basic_json/patch.md index 3ca5aebf3..b3ef963f0 100644 --- a/doc/mkdocs/docs/api/basic_json/patch.md +++ b/doc/mkdocs/docs/api/basic_json/patch.md @@ -1,4 +1,4 @@ -# basic_json::patch +# nlohmann::basic_json::patch ```cpp basic_json patch(const basic_json& json_patch) const; diff --git a/doc/mkdocs/docs/api/basic_json/push_back.md b/doc/mkdocs/docs/api/basic_json/push_back.md index d24842409..60bfed305 100644 --- a/doc/mkdocs/docs/api/basic_json/push_back.md +++ b/doc/mkdocs/docs/api/basic_json/push_back.md @@ -1,4 +1,4 @@ -# basic_json::push_back +# nlohmann::basic_json::push_back ```cpp // (1) diff --git a/doc/mkdocs/docs/api/basic_json/rbegin.md b/doc/mkdocs/docs/api/basic_json/rbegin.md index 0c94bb818..126c47127 100644 --- a/doc/mkdocs/docs/api/basic_json/rbegin.md +++ b/doc/mkdocs/docs/api/basic_json/rbegin.md @@ -1,4 +1,4 @@ -# basic_json::rbegin +# nlohmann::basic_json::rbegin ```cpp reverse_iterator rbegin() noexcept; diff --git a/doc/mkdocs/docs/api/basic_json/rend.md b/doc/mkdocs/docs/api/basic_json/rend.md index 74a261bb3..96da7a5f5 100644 --- a/doc/mkdocs/docs/api/basic_json/rend.md +++ b/doc/mkdocs/docs/api/basic_json/rend.md @@ -1,4 +1,4 @@ -# basic_json::rend +# nlohmann::basic_json::rend ```cpp reverse_iterator rend() noexcept; diff --git a/doc/mkdocs/docs/api/basic_json/sax_parse.md b/doc/mkdocs/docs/api/basic_json/sax_parse.md index afed0b1e9..3d54ad399 100644 --- a/doc/mkdocs/docs/api/basic_json/sax_parse.md +++ b/doc/mkdocs/docs/api/basic_json/sax_parse.md @@ -1,4 +1,4 @@ -# basic_json::sax_parse +# nlohmann::basic_json::sax_parse ```cpp // (1) diff --git a/doc/mkdocs/docs/api/basic_json/size.md b/doc/mkdocs/docs/api/basic_json/size.md index ce4ee8eb7..9d97bb6f6 100644 --- a/doc/mkdocs/docs/api/basic_json/size.md +++ b/doc/mkdocs/docs/api/basic_json/size.md @@ -1,4 +1,4 @@ -# basic_json::size +# nlohmann::basic_json::size ```cpp size_type size() const noexcept; diff --git a/doc/mkdocs/docs/api/basic_json/std_hash.md b/doc/mkdocs/docs/api/basic_json/std_hash.md index 3e9cc997a..b66515d5a 100644 --- a/doc/mkdocs/docs/api/basic_json/std_hash.md +++ b/doc/mkdocs/docs/api/basic_json/std_hash.md @@ -1,4 +1,4 @@ -# std::hash +# std::hash ```cpp namespace std { @@ -10,6 +10,22 @@ Return a hash value for a JSON object. The hash function tries to rely on `std:: type of the JSON value is taken into account to have different hash values for `#!json null`, `#!cpp 0`, `#!cpp 0U`, and `#!cpp false`, etc. +## Examples + +??? example + + The example shows how to calculate hash values for different JSON values. + + ```cpp + --8<-- "examples/std_hash.cpp" + ``` + + Output: + + ```json + --8<-- "examples/std_hash.output" + ``` + ## Version history - Added in version 1.0.0. diff --git a/doc/mkdocs/docs/api/basic_json/string_t.md b/doc/mkdocs/docs/api/basic_json/string_t.md index f6287f894..b8990bc39 100644 --- a/doc/mkdocs/docs/api/basic_json/string_t.md +++ b/doc/mkdocs/docs/api/basic_json/string_t.md @@ -1,4 +1,4 @@ -# basic_json::string_t +# nlohmann::basic_json::string_t ```cpp using string_t = StringType; diff --git a/doc/mkdocs/docs/api/basic_json/swap.md b/doc/mkdocs/docs/api/basic_json/swap.md index 790f39db9..a5730ffa7 100644 --- a/doc/mkdocs/docs/api/basic_json/swap.md +++ b/doc/mkdocs/docs/api/basic_json/swap.md @@ -1,4 +1,4 @@ -# basic_json::swap +# nlohmann::basic_json::swap ```cpp // (1) diff --git a/doc/mkdocs/docs/api/basic_json/to_bson.md b/doc/mkdocs/docs/api/basic_json/to_bson.md index ad4811b4f..664dd0e20 100644 --- a/doc/mkdocs/docs/api/basic_json/to_bson.md +++ b/doc/mkdocs/docs/api/basic_json/to_bson.md @@ -1,4 +1,4 @@ -# basic_json::to_bson +# nlohmann::basic_json::to_bson ```cpp // (1) diff --git a/doc/mkdocs/docs/api/basic_json/to_cbor.md b/doc/mkdocs/docs/api/basic_json/to_cbor.md index 5dc7836f2..05d85ed85 100644 --- a/doc/mkdocs/docs/api/basic_json/to_cbor.md +++ b/doc/mkdocs/docs/api/basic_json/to_cbor.md @@ -1,4 +1,4 @@ -# basic_json::to_cbor +# nlohmann::basic_json::to_cbor ```cpp // (1) diff --git a/doc/mkdocs/docs/api/basic_json/to_msgpack.md b/doc/mkdocs/docs/api/basic_json/to_msgpack.md index 4b640c63a..fb4b40bd0 100644 --- a/doc/mkdocs/docs/api/basic_json/to_msgpack.md +++ b/doc/mkdocs/docs/api/basic_json/to_msgpack.md @@ -1,4 +1,4 @@ -# basic_json::to_msgpack +# nlohmann::basic_json::to_msgpack ```cpp // (1) diff --git a/doc/mkdocs/docs/api/basic_json/to_ubjson.md b/doc/mkdocs/docs/api/basic_json/to_ubjson.md index 2edc0638f..0a3d87e54 100644 --- a/doc/mkdocs/docs/api/basic_json/to_ubjson.md +++ b/doc/mkdocs/docs/api/basic_json/to_ubjson.md @@ -1,4 +1,4 @@ -# basic_json::to_ubjson +# nlohmann::basic_json::to_ubjson ```cpp // (1) diff --git a/doc/mkdocs/docs/api/basic_json/type.md b/doc/mkdocs/docs/api/basic_json/type.md index 15b09d8fe..32c3927cd 100644 --- a/doc/mkdocs/docs/api/basic_json/type.md +++ b/doc/mkdocs/docs/api/basic_json/type.md @@ -1,4 +1,4 @@ -# basic_json::type +# nlohmann::basic_json::type ```cpp constexpr value_t type() const noexcept; diff --git a/doc/mkdocs/docs/api/basic_json/type_error.md b/doc/mkdocs/docs/api/basic_json/type_error.md index 3991587af..cda54c089 100644 --- a/doc/mkdocs/docs/api/basic_json/type_error.md +++ b/doc/mkdocs/docs/api/basic_json/type_error.md @@ -1,4 +1,4 @@ -# basic_json::type_error +# nlohmann::basic_json::type_error ```cpp class type_error : public exception; diff --git a/doc/mkdocs/docs/api/basic_json/type_name.md b/doc/mkdocs/docs/api/basic_json/type_name.md index d35b8220c..d9e8cf012 100644 --- a/doc/mkdocs/docs/api/basic_json/type_name.md +++ b/doc/mkdocs/docs/api/basic_json/type_name.md @@ -1,4 +1,4 @@ -# basic_json::type_name +# nlohmann::basic_json::type_name ```cpp const char* type_name() const noexcept; diff --git a/doc/mkdocs/docs/api/basic_json/unflatten.md b/doc/mkdocs/docs/api/basic_json/unflatten.md index 23c8b0751..d9778036c 100644 --- a/doc/mkdocs/docs/api/basic_json/unflatten.md +++ b/doc/mkdocs/docs/api/basic_json/unflatten.md @@ -1,4 +1,4 @@ -# basic_json::unflatten +# nlohmann::basic_json::unflatten ```cpp basic_json unflatten() const; diff --git a/doc/mkdocs/docs/api/basic_json/update.md b/doc/mkdocs/docs/api/basic_json/update.md index f6fb2fec2..96e012250 100644 --- a/doc/mkdocs/docs/api/basic_json/update.md +++ b/doc/mkdocs/docs/api/basic_json/update.md @@ -1,4 +1,4 @@ -# basic_json::update +# nlohmann::basic_json::update ```cpp // (1) diff --git a/doc/mkdocs/docs/api/basic_json/value.md b/doc/mkdocs/docs/api/basic_json/value.md index 18135a44c..0aad71483 100644 --- a/doc/mkdocs/docs/api/basic_json/value.md +++ b/doc/mkdocs/docs/api/basic_json/value.md @@ -1,4 +1,4 @@ -# basic_json::value +# nlohmann::basic_json::value ```cpp // (1) diff --git a/doc/mkdocs/docs/api/basic_json/value_t.md b/doc/mkdocs/docs/api/basic_json/value_t.md index fc9b38f4d..768b13ca1 100644 --- a/doc/mkdocs/docs/api/basic_json/value_t.md +++ b/doc/mkdocs/docs/api/basic_json/value_t.md @@ -1,4 +1,4 @@ -# basic_json::value_t +# nlohmann::basic_json::value_t ```cpp enum class value_t : std::uint8_t { diff --git a/doc/mkdocs/docs/api/basic_json/~basic_json.md b/doc/mkdocs/docs/api/basic_json/~basic_json.md index 9ffea2a84..c5c74a525 100644 --- a/doc/mkdocs/docs/api/basic_json/~basic_json.md +++ b/doc/mkdocs/docs/api/basic_json/~basic_json.md @@ -1,4 +1,4 @@ -# basic_json::~basic_json +# nlohmann::basic_json::~basic_json ```cpp ~basic_json() noexcept; diff --git a/doc/mkdocs/docs/api/byte_container_with_subtype/byte_container_with_subtype.md b/doc/mkdocs/docs/api/byte_container_with_subtype/byte_container_with_subtype.md index 895fbe2bb..caa273df5 100644 --- a/doc/mkdocs/docs/api/byte_container_with_subtype/byte_container_with_subtype.md +++ b/doc/mkdocs/docs/api/byte_container_with_subtype/byte_container_with_subtype.md @@ -1,4 +1,4 @@ -# byte_container_with_subtype::byte_container_with_subtype +# nlohmann::byte_container_with_subtype::byte_container_with_subtype ```cpp // (1) diff --git a/doc/mkdocs/docs/api/byte_container_with_subtype/clear_subtype.md b/doc/mkdocs/docs/api/byte_container_with_subtype/clear_subtype.md index c87b3d666..56f8ee0c1 100644 --- a/doc/mkdocs/docs/api/byte_container_with_subtype/clear_subtype.md +++ b/doc/mkdocs/docs/api/byte_container_with_subtype/clear_subtype.md @@ -1,4 +1,4 @@ -# byte_container_with_subtype::clear_subtype +# nlohmann::byte_container_with_subtype::clear_subtype ```cpp void clear_subtype() noexcept; diff --git a/doc/mkdocs/docs/api/byte_container_with_subtype/has_subtype.md b/doc/mkdocs/docs/api/byte_container_with_subtype/has_subtype.md index 80afaf11e..2fe418132 100644 --- a/doc/mkdocs/docs/api/byte_container_with_subtype/has_subtype.md +++ b/doc/mkdocs/docs/api/byte_container_with_subtype/has_subtype.md @@ -1,4 +1,4 @@ -# byte_container_with_subtype::has_subtype +# nlohmann::byte_container_with_subtype::has_subtype ```cpp constexpr bool has_subtype() const noexcept; diff --git a/doc/mkdocs/docs/api/byte_container_with_subtype/index.md b/doc/mkdocs/docs/api/byte_container_with_subtype/index.md index f1f18482b..277fffa34 100644 --- a/doc/mkdocs/docs/api/byte_container_with_subtype/index.md +++ b/doc/mkdocs/docs/api/byte_container_with_subtype/index.md @@ -1,4 +1,4 @@ -# byte_container_with_subtype +# nlohmann::byte_container_with_subtype ```cpp template diff --git a/doc/mkdocs/docs/api/byte_container_with_subtype/set_subtype.md b/doc/mkdocs/docs/api/byte_container_with_subtype/set_subtype.md index 7b78aea99..40cc2722f 100644 --- a/doc/mkdocs/docs/api/byte_container_with_subtype/set_subtype.md +++ b/doc/mkdocs/docs/api/byte_container_with_subtype/set_subtype.md @@ -1,4 +1,4 @@ -# byte_container_with_subtype::set_subtype +# nlohmann::byte_container_with_subtype::set_subtype ```cpp void set_subtype(subtype_type subtype) noexcept; diff --git a/doc/mkdocs/docs/api/byte_container_with_subtype/subtype.md b/doc/mkdocs/docs/api/byte_container_with_subtype/subtype.md index 0e9f034d4..e78654b37 100644 --- a/doc/mkdocs/docs/api/byte_container_with_subtype/subtype.md +++ b/doc/mkdocs/docs/api/byte_container_with_subtype/subtype.md @@ -1,4 +1,4 @@ -# byte_container_with_subtype::subtype +# nlohmann::byte_container_with_subtype::subtype ```cpp constexpr subtype_type subtype() const noexcept; diff --git a/doc/mkdocs/docs/api/json.md b/doc/mkdocs/docs/api/json.md index ac26bc025..48d344183 100644 --- a/doc/mkdocs/docs/api/json.md +++ b/doc/mkdocs/docs/api/json.md @@ -1,4 +1,4 @@ -# json +# nlohmann::json ```cpp using json = basic_json<>; diff --git a/doc/mkdocs/docs/api/json_pointer/back.md b/doc/mkdocs/docs/api/json_pointer/back.md index a16e98d96..2b267bc58 100644 --- a/doc/mkdocs/docs/api/json_pointer/back.md +++ b/doc/mkdocs/docs/api/json_pointer/back.md @@ -1,4 +1,4 @@ -# json_pointer::back +# nlohmann::json_pointer::back ```cpp const std::string& back() const; diff --git a/doc/mkdocs/docs/api/json_pointer/empty.md b/doc/mkdocs/docs/api/json_pointer/empty.md index 4418e6859..346364ad5 100644 --- a/doc/mkdocs/docs/api/json_pointer/empty.md +++ b/doc/mkdocs/docs/api/json_pointer/empty.md @@ -1,4 +1,4 @@ -# json_pointer::empty +# nlohmann::json_pointer::empty ```cpp bool empty() const noexcept; diff --git a/doc/mkdocs/docs/api/json_pointer/index.md b/doc/mkdocs/docs/api/json_pointer/index.md index 7c9df7cff..6ef9435fb 100644 --- a/doc/mkdocs/docs/api/json_pointer/index.md +++ b/doc/mkdocs/docs/api/json_pointer/index.md @@ -1,4 +1,4 @@ -# json_pointer +# nlohmann::json_pointer ```cpp template diff --git a/doc/mkdocs/docs/api/json_pointer/json_pointer.md b/doc/mkdocs/docs/api/json_pointer/json_pointer.md index 9d08f9c31..1e68a28f3 100644 --- a/doc/mkdocs/docs/api/json_pointer/json_pointer.md +++ b/doc/mkdocs/docs/api/json_pointer/json_pointer.md @@ -1,4 +1,4 @@ -# json_pointer::json_pointer +# nlohmann::json_pointer::json_pointer ```cpp explicit json_pointer(const std::string& s = ""); diff --git a/doc/mkdocs/docs/api/json_pointer/operator_slash.md b/doc/mkdocs/docs/api/json_pointer/operator_slash.md index 504f66b63..c92875435 100644 --- a/doc/mkdocs/docs/api/json_pointer/operator_slash.md +++ b/doc/mkdocs/docs/api/json_pointer/operator_slash.md @@ -1,4 +1,4 @@ -# json_pointer::operator/ +# nlohmann::json_pointer::operator/ ```cpp // (1) diff --git a/doc/mkdocs/docs/api/json_pointer/operator_slasheq.md b/doc/mkdocs/docs/api/json_pointer/operator_slasheq.md index f92664193..eb6c30861 100644 --- a/doc/mkdocs/docs/api/json_pointer/operator_slasheq.md +++ b/doc/mkdocs/docs/api/json_pointer/operator_slasheq.md @@ -1,4 +1,4 @@ -# json_pointer::operator/= +# nlohmann::json_pointer::operator/= ```cpp // (1) diff --git a/doc/mkdocs/docs/api/json_pointer/operator_string.md b/doc/mkdocs/docs/api/json_pointer/operator_string.md index 881bff524..56d8eebeb 100644 --- a/doc/mkdocs/docs/api/json_pointer/operator_string.md +++ b/doc/mkdocs/docs/api/json_pointer/operator_string.md @@ -1,4 +1,4 @@ -# json_pointer::operator std::string +# nlohmann::json_pointer::operator std::string ```cpp operator std::string() const diff --git a/doc/mkdocs/docs/api/json_pointer/parent_pointer.md b/doc/mkdocs/docs/api/json_pointer/parent_pointer.md index 1ec92c83b..139873072 100644 --- a/doc/mkdocs/docs/api/json_pointer/parent_pointer.md +++ b/doc/mkdocs/docs/api/json_pointer/parent_pointer.md @@ -1,4 +1,4 @@ -# json_pointer::parent_pointer +# nlohmann::json_pointer::parent_pointer ```cpp json_pointer parent_pointer() const; diff --git a/doc/mkdocs/docs/api/json_pointer/pop_back.md b/doc/mkdocs/docs/api/json_pointer/pop_back.md index 9b570c501..3c79f3638 100644 --- a/doc/mkdocs/docs/api/json_pointer/pop_back.md +++ b/doc/mkdocs/docs/api/json_pointer/pop_back.md @@ -1,4 +1,4 @@ -# json_pointer::pop_back +# nlohmann::json_pointer::pop_back ```cpp void pop_back(); diff --git a/doc/mkdocs/docs/api/json_pointer/push_back.md b/doc/mkdocs/docs/api/json_pointer/push_back.md index 581ddd94d..3ebcdbc5c 100644 --- a/doc/mkdocs/docs/api/json_pointer/push_back.md +++ b/doc/mkdocs/docs/api/json_pointer/push_back.md @@ -1,4 +1,4 @@ -# json_pointer::push_back +# nlohmann::json_pointer::push_back ```cpp void push_back(const std::string& token); diff --git a/doc/mkdocs/docs/api/json_pointer/to_string.md b/doc/mkdocs/docs/api/json_pointer/to_string.md index 6c802c74c..9287436e3 100644 --- a/doc/mkdocs/docs/api/json_pointer/to_string.md +++ b/doc/mkdocs/docs/api/json_pointer/to_string.md @@ -1,4 +1,4 @@ -# json_pointer::to_string +# nlohmann::json_pointer::to_string ```cpp std::string to_string() const; diff --git a/doc/mkdocs/docs/api/json_sax/binary.md b/doc/mkdocs/docs/api/json_sax/binary.md index 98254a067..e9a1d3974 100644 --- a/doc/mkdocs/docs/api/json_sax/binary.md +++ b/doc/mkdocs/docs/api/json_sax/binary.md @@ -1,4 +1,4 @@ -# json_sax::binary +# nlohmann::json_sax::binary ```cpp virtual bool binary(binary_t& val) = 0; diff --git a/doc/mkdocs/docs/api/json_sax/boolean.md b/doc/mkdocs/docs/api/json_sax/boolean.md index acba6a986..a5a8ddcb7 100644 --- a/doc/mkdocs/docs/api/json_sax/boolean.md +++ b/doc/mkdocs/docs/api/json_sax/boolean.md @@ -1,4 +1,4 @@ -# json_sax::boolean +# nlohmann::json_sax::boolean ```cpp virtual bool boolean(bool val) = 0; diff --git a/doc/mkdocs/docs/api/json_sax/end_array.md b/doc/mkdocs/docs/api/json_sax/end_array.md index 279ee54f2..245cf974c 100644 --- a/doc/mkdocs/docs/api/json_sax/end_array.md +++ b/doc/mkdocs/docs/api/json_sax/end_array.md @@ -1,4 +1,4 @@ -# json_sax::end_array +# nlohmann::json_sax::end_array ```cpp virtual bool end_array() = 0; diff --git a/doc/mkdocs/docs/api/json_sax/end_object.md b/doc/mkdocs/docs/api/json_sax/end_object.md index 011c0ae6f..5654e262e 100644 --- a/doc/mkdocs/docs/api/json_sax/end_object.md +++ b/doc/mkdocs/docs/api/json_sax/end_object.md @@ -1,4 +1,4 @@ -# json_sax::end_object +# nlohmann::json_sax::end_object ```cpp virtual bool end_object() = 0; diff --git a/doc/mkdocs/docs/api/json_sax/index.md b/doc/mkdocs/docs/api/json_sax/index.md index 24f008354..f63e85c9a 100644 --- a/doc/mkdocs/docs/api/json_sax/index.md +++ b/doc/mkdocs/docs/api/json_sax/index.md @@ -1,4 +1,4 @@ -# json_sax +# nlohmann::json_sax ```cpp template diff --git a/doc/mkdocs/docs/api/json_sax/key.md b/doc/mkdocs/docs/api/json_sax/key.md index 9afcea3a2..5e7927256 100644 --- a/doc/mkdocs/docs/api/json_sax/key.md +++ b/doc/mkdocs/docs/api/json_sax/key.md @@ -1,4 +1,4 @@ -# json_sax::key +# nlohmann::json_sax::key ```cpp virtual bool key(string_t& val) = 0; diff --git a/doc/mkdocs/docs/api/json_sax/null.md b/doc/mkdocs/docs/api/json_sax/null.md index 54c25bf4c..bcbb4a348 100644 --- a/doc/mkdocs/docs/api/json_sax/null.md +++ b/doc/mkdocs/docs/api/json_sax/null.md @@ -1,4 +1,4 @@ -# json_sax::null +# nlohmann::json_sax::null ```cpp virtual bool null() = 0; diff --git a/doc/mkdocs/docs/api/json_sax/number_float.md b/doc/mkdocs/docs/api/json_sax/number_float.md index 39304d3aa..94193280b 100644 --- a/doc/mkdocs/docs/api/json_sax/number_float.md +++ b/doc/mkdocs/docs/api/json_sax/number_float.md @@ -1,4 +1,4 @@ -# json_sax::number_float +# nlohmann::json_sax::number_float ```cpp virtual bool number_float(number_float_t val, const string_t& s) = 0; diff --git a/doc/mkdocs/docs/api/json_sax/number_integer.md b/doc/mkdocs/docs/api/json_sax/number_integer.md index 9343b6e7a..00ff2eaa6 100644 --- a/doc/mkdocs/docs/api/json_sax/number_integer.md +++ b/doc/mkdocs/docs/api/json_sax/number_integer.md @@ -1,4 +1,4 @@ -# json_sax::number_integer +# nlohmann::json_sax::number_integer ```cpp virtual bool number_integer(number_integer_t val) = 0; diff --git a/doc/mkdocs/docs/api/json_sax/number_unsigned.md b/doc/mkdocs/docs/api/json_sax/number_unsigned.md index fef363e87..66d0bdac4 100644 --- a/doc/mkdocs/docs/api/json_sax/number_unsigned.md +++ b/doc/mkdocs/docs/api/json_sax/number_unsigned.md @@ -1,4 +1,4 @@ -# json_sax::number_unsigned +# nlohmann::json_sax::number_unsigned ```cpp virtual bool number_unsigned(number_unsigned_t val) = 0; diff --git a/doc/mkdocs/docs/api/json_sax/parse_error.md b/doc/mkdocs/docs/api/json_sax/parse_error.md index a229b243e..00f1aa950 100644 --- a/doc/mkdocs/docs/api/json_sax/parse_error.md +++ b/doc/mkdocs/docs/api/json_sax/parse_error.md @@ -1,4 +1,4 @@ -# json_sax::parse_error +# nlohmann::json_sax::parse_error ```cpp virtual bool parse_error(std::size_t position, diff --git a/doc/mkdocs/docs/api/json_sax/start_array.md b/doc/mkdocs/docs/api/json_sax/start_array.md index 16855ee18..d10a6e5a6 100644 --- a/doc/mkdocs/docs/api/json_sax/start_array.md +++ b/doc/mkdocs/docs/api/json_sax/start_array.md @@ -1,4 +1,4 @@ -# json_sax::start_array +# nlohmann::json_sax::start_array ```cpp virtual bool start_array(std::size_t elements) = 0; diff --git a/doc/mkdocs/docs/api/json_sax/start_object.md b/doc/mkdocs/docs/api/json_sax/start_object.md index 34103cd22..fd90f1947 100644 --- a/doc/mkdocs/docs/api/json_sax/start_object.md +++ b/doc/mkdocs/docs/api/json_sax/start_object.md @@ -1,4 +1,4 @@ -# json_sax::start_object +# nlohmann::json_sax::start_object ```cpp virtual bool start_object(std::size_t elements) = 0; diff --git a/doc/mkdocs/docs/api/json_sax/string.md b/doc/mkdocs/docs/api/json_sax/string.md index f0ab328eb..113fe1393 100644 --- a/doc/mkdocs/docs/api/json_sax/string.md +++ b/doc/mkdocs/docs/api/json_sax/string.md @@ -1,4 +1,4 @@ -# json_sax::string +# nlohmann::json_sax::string ```cpp virtual bool string(string_t& val) = 0; diff --git a/doc/mkdocs/docs/api/ordered_json.md b/doc/mkdocs/docs/api/ordered_json.md index 873f68b20..8b122f90b 100644 --- a/doc/mkdocs/docs/api/ordered_json.md +++ b/doc/mkdocs/docs/api/ordered_json.md @@ -1,7 +1,7 @@ -# ordered_json +# nlohmann::ordered_json ```cpp -using ordered_json = basic_json; +using ordered_json = basic_json; ``` This type preserves the insertion order of object keys. diff --git a/doc/mkdocs/docs/api/ordered_map.md b/doc/mkdocs/docs/api/ordered_map.md index 423821c1c..74b248ff2 100644 --- a/doc/mkdocs/docs/api/ordered_map.md +++ b/doc/mkdocs/docs/api/ordered_map.md @@ -1,4 +1,4 @@ -# ordered_map +# nlohmann::ordered_map ```cpp template, @@ -6,7 +6,8 @@ template, struct ordered_map : std::vector, Allocator>; ``` -A minimal map-like container that preserves insertion order for use within `nlohmann::basic_json`. +A minimal map-like container that preserves insertion order for use within [`nlohmann::ordered_json`](ordered_json.md) +(`nlohmann::basic_json`). ## Template parameters @@ -17,7 +18,7 @@ A minimal map-like container that preserves insertion order for use within `nloh : mapped type `IgnoredLess` -: comparison function (ignored and only added to ensure compatibility with `std::map`) +: comparison function (ignored and only added to ensure compatibility with `#!cpp std::map`) `Allocator` : allocator type @@ -44,6 +45,26 @@ A minimal map-like container that preserves insertion order for use within `nloh - **find** - **insert** +## Examples + +??? example + + The example shows the different behavior of `std::map` and `nlohmann::ordered_map`. + + ```cpp + --8<-- "examples/ordered_map.cpp" + ``` + + Output: + + ```json + --8<-- "examples/ordered_map.output" + ``` + +## See also + +- [ordered_json](ordered_json.md) + ## Version history - Added in version 3.9.0 to implement [`nlohmann::ordered_json`](ordered_json.md). diff --git a/doc/mkdocs/mkdocs.yml b/doc/mkdocs/mkdocs.yml index 539cc21fe..d716c2d9a 100644 --- a/doc/mkdocs/mkdocs.yml +++ b/doc/mkdocs/mkdocs.yml @@ -198,7 +198,7 @@ nav: - 'Overview': api/adl_serializer/index.md - 'from_json': api/adl_serializer/from_json.md - 'to_json': api/adl_serializer/to_json.md - - api/json.md + - 'json': api/json.md - json_pointer: - 'Overview': api/json_pointer/index.md - '(Constructor)': api/json_pointer/json_pointer.md @@ -226,8 +226,8 @@ nav: - 'start_array': api/json_sax/start_array.md - 'start_object': api/json_sax/start_object.md - 'string': api/json_sax/string.md - - api/ordered_map.md - - api/ordered_json.md + - 'ordered_json': api/ordered_json.md + - 'ordered_map': api/ordered_map.md # Extras extra: diff --git a/doc/mkdocs/scripts/check_structure.py b/doc/mkdocs/scripts/check_structure.py index a256622a8..82d84b1e0 100644 --- a/doc/mkdocs/scripts/check_structure.py +++ b/doc/mkdocs/scripts/check_structure.py @@ -29,6 +29,7 @@ def check_structure(): ] required_headers = [ + 'Examples', 'Version history' ]