Consolidate documentation (#3071)

* 🔥 consolidate documentation
* ♻ overwork std specializations
* 🚚 move images files to mkdocs
* ♻ fix URLs
* 🔧 tweak MkDocs configuration
* 🔧 add namespaces
* 📝 document deprecations
* 📝 document documentation generation
* 🚸 improve search
* 🚸 add examples
* 🚧 start adding documentation for macros
* 📝 add note for https://github.com/nlohmann/json/issues/874#issuecomment-1001699139
* 📝 overwork example handling
* 📝 fix Markdown tables

.gitignore

@@ -25,7 +25,6 @@ test/test-*
 
 doc/html
 doc/mkdocs/venv/
-doc/mkdocs/docs/images
 doc/mkdocs/docs/examples
 doc/mkdocs/site
 doc/mkdocs/docs/__pycache__/

doc/Makefile

 SRCDIR = ../single_include
-SED:=$(shell command -v gsed || which sed)
-
-all: doxygen
 
+all: create_output
 
 ##########################################################################
 # example files
@@ -24,49 +22,13 @@ EXAMPLES = $(wildcard examples/*.cpp)
 	diff $@ $(<:.cpp=.output)
 	rm $(<:.cpp=) $@
 
-# create links to try the code online
-%.link: %.cpp
-	rm -fr tmp
-	mkdir tmp
-	cp -r $(SRCDIR)/nlohmann tmp
-	python2 scripts/send_to_wandbox.py tmp $< > $@.tmp
-	/bin/echo -n "<a target=\"_blank\" href=\"`cat $@.tmp`\"><b>online</b></a>" > $@
-	rm -fr tmp $@.tmp
-
 # create output from all stand-alone example files
 create_output: $(EXAMPLES:.cpp=.output)
 
-create_links: $(EXAMPLES:.cpp=.link)
-
 # check output of all stand-alone example files
 check_output: $(EXAMPLES:.cpp=.test)
 
-
 clean:
-	rm -fr me.nlohmann.json.docset html $(EXAMPLES:.cpp=)
+	rm -fr $(EXAMPLES:.cpp=)
 	$(MAKE) clean -C docset
 	$(MAKE) clean -C mkdocs
-
-
-##########################################################################
-# Doxygen HTML documentation
-##########################################################################
-
-# create Doxygen documentation
-doxygen: create_output create_links
-	doxygen
-	$(SED) -i 's@&lt; ObjectType, ArrayType, StringType, BooleanType, NumberIntegerType, NumberFloatType, AllocatorType, JSONSerializer &gt;@@g' html/*.html
-	$(SED) -i 's@&lt;&#160;ObjectType,&#160;ArrayType,&#160;StringType,&#160;BooleanType,&#160;NumberIntegerType,&#160;NumberFloatType,&#160;AllocatorType&#160;JSONSerializer&#160;&gt;@@g' html/*.html
-	$(SED) -i 's@&lt; ObjectType, ArrayType, StringType, BooleanType, NumberIntegerType, NumberUnsignedType, NumberFloatType, AllocatorType, JSONSerializer &gt;@@g' html/*.html
-	$(SED) -i 's@< ObjectType, ArrayType, StringType, BooleanType, NumberIntegerType, NumberUnsignedType, NumberFloatType, AllocatorType, JSONSerializer >@@g' html/*.html
-	$(SED) -i 's@&lt;&#160;ObjectType,&#160;ArrayType,&#160;StringType,&#160;BooleanType,&#160;NumberIntegerType,&#160;NumberUnsignedType,&#160;NumberFloatType,&#160;AllocatorType&#160;JSONSerializer&#160;&gt;@@g' html/*.html
-	$(SED) -i 's@template&lt;template&lt; typename U, typename V, typename... Args &gt; class ObjectType = std::map, template&lt; typename U, typename... Args &gt; class ArrayType = std::vector, class StringType = std::string, class BooleanType = bool, class NumberIntegerType = std::int64_t, class NumberUnsignedType = std::uint64_t, class NumberFloatType = double, template&lt; typename U &gt; class AllocatorType = std::allocator, template&lt; typename T, typename SFINAE=void &gt; class JSONSerializer = adl_serializer&gt;@@g' html/*.html
-	$(SED) -i 's@&lt; ObjectType, ArrayType, StringType, BooleanType, NumberIntegerType, NumberUnsignedType, NumberFloatType, AllocatorType, JSONSerializer &gt;@@g' html/*.html
-	$(SED) -i 's@&lt;&#160;ObjectType,&#160;ArrayType,&#160;StringType,&#160;BooleanType,&#160;NumberIntegerType,&#160;NumberUnsignedType,&#160;NumberFloatType,&#160;AllocatorType,&#160;JSONSerializer&#160;&gt;@@g' html/*.html
-	$(SED) -i 's@JSON_HEDLEY_RETURNS_NON_NULL@@g' html/*.html
-	$(SED) -i 's@JSON_HEDLEY_WARN_UNUSED_RESULT@@g' html/*.html
-
-upload: clean doxygen check_output
-	scripts/git-update-ghpages nlohmann/json html
-	rm -fr html
-	open http://nlohmann.github.io/json/

doc/README.md

+# Documentation
+
+## Generate documentation
+
+Note on documentation: The source files contain links to the online documentation at https://json.nlohmann.me. This URL
+contains the most recent documentation and should also be applicable to previous versions; documentation for deprecated
+functions is not removed, but marked deprecated.
+
+If you want to see the documentation for a specific tag or commit hash, you can generate it as follows (here for tag
+`v3.10.2`):
+
+```shell
+git clone https://github.com/nlohmann/json.git
+cd json
+git checkout v3.10.2
+make install_venv serve -C doc/mkdocs
+```
+
+Open URL <http://127.0.0.1:8000/> in your browser. Replace from any URL from the source code `https://json.nlohmann.me`
+with `http://127.0.0.1:8000` to see the documentation for your tag or commit hash.

doc/css/mylayout.css

-/* hide lengthy template information */
-.memtemplate, .memTemplParams {
-    display: none;
-}
-
-/* allow compiler information to wrap */
-/* https://css-tricks.com/snippets/css/make-pre-text-wrap/ */
-pre.fragment {
-    white-space: pre-wrap;       /* css-3 */
-    white-space: -moz-pre-wrap;  /* Mozilla, since 1999 */
-    white-space: -pre-wrap;      /* Opera 4-6 */
-    white-space: -o-pre-wrap;    /* Opera 7 */
-    word-wrap: break-word;       /* Internet Explorer 5.5+ */
-}
-
-td.paramname {
-    vertical-align: top;
-}
-
-.ok_green {
-    background-color: #89C35C;
-}
-
-.nok_throws {
-    background-color: #ffa500;
-}

doc/css/mylayout_docset.css

-.memtemplate {
-    display: none;
-}
-
-.memTemplParams {
-    display: none;
-}
-
-.navtab {
-    display: none;
-}
-
-#top, .footer {
-    display: none;
-}
-
-td.paramname {
-    vertical-align: top;
-}
-
-.ok_green {
-    background-color: #89C35C;
-}
-
-.nok_throws {
-    background-color: #ffa500;
-}

doc/examples/README.link

-<a target="_blank" href="https://wandbox.org/permlink/1mp10JbaANo6FUc7"><b>online</b></a>
\ No newline at end of file

doc/examples/accept__string.link

-<a target="_blank" href="https://wandbox.org/permlink/r5Tai1spihWHTdFA"><b>online</b></a>
\ No newline at end of file

doc/examples/array.link

-<a target="_blank" href="https://wandbox.org/permlink/Ptk2BoNyGfrZfxRU"><b>online</b></a>
\ No newline at end of file

doc/examples/array_t.cpp

+#include <iostream>
+#include <iomanip>
+#include <nlohmann/json.hpp>
+
+using json = nlohmann::json;
+
+int main()
+{
+    std::cout << std::boolalpha << std::is_same<std::vector<json>, json::array_t>::value << std::endl;
+}

doc/examples/array_t.output

+true

doc/examples/at__object_t_key_type.link

-<a target="_blank" href="https://wandbox.org/permlink/055DW3OWJPwGYr92"><b>online</b></a>
\ No newline at end of file

doc/examples/at__object_t_key_type_const.link

-<a target="_blank" href="https://wandbox.org/permlink/gM1uqvzukokLwjMa"><b>online</b></a>
\ No newline at end of file

doc/examples/at__size_type.link

-<a target="_blank" href="https://wandbox.org/permlink/H3tBOr4lpufGRHlF"><b>online</b></a>
\ No newline at end of file

doc/examples/at__size_type_const.link

-<a target="_blank" href="https://wandbox.org/permlink/UtGhIQGxCYIml36F"><b>online</b></a>
\ No newline at end of file

doc/examples/at_json_pointer.cpp

@@ -60,7 +60,7 @@ int main()
     // out_of_range.401
     try
     {
-        // try to use a an invalid array index
+        // try to use an invalid array index
         json::reference ref = j.at("/array/4"_json_pointer);
     }
     catch (json::out_of_range& e)
@@ -82,7 +82,7 @@ int main()
     // out_of_range.403
     try
     {
-        // try to use a JSON pointer to an nonexistent object key
+        // try to use a JSON pointer to a nonexistent object key
         json::const_reference ref = j.at("/foo"_json_pointer);
     }
     catch (json::out_of_range& e)

doc/examples/at_json_pointer.link

-<a target="_blank" href="https://wandbox.org/permlink/NHe5FLR1KYaiHwBx"><b>online</b></a>
\ No newline at end of file

doc/examples/at_json_pointer_const.cpp

@@ -36,7 +36,7 @@ int main()
     // out_of_range.401
     try
     {
-        // try to use a an invalid array index
+        // try to use an invalid array index
         json::const_reference ref = j.at("/array/4"_json_pointer);
     }
     catch (json::out_of_range& e)
@@ -58,7 +58,7 @@ int main()
     // out_of_range.403
     try
     {
-        // try to use a JSON pointer to an nonexistent object key
+        // try to use a JSON pointer to a nonexistent object key
         json::const_reference ref = j.at("/foo"_json_pointer);
     }
     catch (json::out_of_range& e)

doc/examples/at_json_pointer_const.link

-<a target="_blank" href="https://wandbox.org/permlink/lbZjdwg6yII33cV5"><b>online</b></a>
\ No newline at end of file

doc/examples/back.link

-<a target="_blank" href="https://wandbox.org/permlink/swnzqmd8zj6ij1fb"><b>online</b></a>
\ No newline at end of file

doc/examples/basic_json__CompatibleType.cpp

@@ -81,7 +81,7 @@ int main()
     json j_list(c_list);
 
     // create an array from std::forward_list
-    std::forward_list<int64_t> c_flist {12345678909876, 23456789098765, 34567890987654, 45678909876543};
+    std::forward_list<std::int64_t> c_flist {12345678909876, 23456789098765, 34567890987654, 45678909876543};
     json j_flist(c_flist);
 
     // create an array from std::array

doc/examples/basic_json__CompatibleType.link

-<a target="_blank" href="https://wandbox.org/permlink/RodBcX8vpcP5dQ40"><b>online</b></a>
\ No newline at end of file

doc/examples/basic_json__InputIt_InputIt.link

-<a target="_blank" href="https://wandbox.org/permlink/oWFo4AhVlMBjNv8E"><b>online</b></a>
\ No newline at end of file

doc/examples/basic_json__basic_json.link

-<a target="_blank" href="https://wandbox.org/permlink/oRn0YsYyurs0Zi5T"><b>online</b></a>
\ No newline at end of file

doc/examples/basic_json__copyassignment.link

-<a target="_blank" href="https://wandbox.org/permlink/kVknQzPMpqjywTpG"><b>online</b></a>
\ No newline at end of file

doc/examples/basic_json__list_init_t.link

-<a target="_blank" href="https://wandbox.org/permlink/yzkjGGzMOESBkCdH"><b>online</b></a>
\ No newline at end of file

doc/examples/basic_json__moveconstructor.link

-<a target="_blank" href="https://wandbox.org/permlink/eIOvQiuID2qgxp5u"><b>online</b></a>
\ No newline at end of file

doc/examples/basic_json__nullptr_t.link

-<a target="_blank" href="https://wandbox.org/permlink/Vm0nR32x6co8rq40"><b>online</b></a>
\ No newline at end of file

doc/examples/basic_json__size_type_basic_json.link

-<a target="_blank" href="https://wandbox.org/permlink/w4TtEQzlVyokIrtp"><b>online</b></a>
\ No newline at end of file

doc/examples/basic_json__value.link

-<a target="_blank" href="https://wandbox.org/permlink/mNy1nyabOkeHfHGf"><b>online</b></a>
\ No newline at end of file

doc/examples/basic_json__value_ptr.link

-<a target="_blank" href="https://wandbox.org/permlink/a3H6kpORXgbVXylv"><b>online</b></a>
\ No newline at end of file

doc/examples/basic_json__value_t.link

-<a target="_blank" href="https://wandbox.org/permlink/yXZGDwDHH3LOuFIr"><b>online</b></a>
\ No newline at end of file

doc/examples/begin.link

-<a target="_blank" href="https://wandbox.org/permlink/fS4kfQG1hmhjMScn"><b>online</b></a>
\ No newline at end of file

doc/examples/binary.cpp

+#include <iostream>
+#include <nlohmann/json.hpp>
+
+using json = nlohmann::json;
+
+int main()
+{
+    // create a binary vector
+    std::vector<std::uint8_t> vec = {0xCA, 0xFE, 0xBA, 0xBE};
+
+    // create a binary JSON value with subtype 42
+    json j = json::binary(vec, 42);
+
+    // output type and subtype
+    std::cout << "type: " << j.type_name() << ", subtype: " << j.get_binary().subtype() << std::endl;
+}

doc/examples/binary.output

+type: binary, subtype: 42

doc/examples/binary_t.cpp

+#include <iostream>
+#include <iomanip>
+#include <nlohmann/json.hpp>
+
+using json = nlohmann::json;
+
+int main()
+{
+    std::cout << std::boolalpha << std::is_same<nlohmann::byte_container_with_subtype<std::vector<std::uint8_t>>, json::binary_t>::value << std::endl;
+}

doc/examples/binary_t.output

+true

doc/examples/boolean_t.cpp

+#include <iostream>
+#include <iomanip>
+#include <nlohmann/json.hpp>
+
+using json = nlohmann::json;
+
+int main()
+{
+    std::cout << std::boolalpha << std::is_same<bool, json::boolean_t>::value << std::endl;
+}

doc/examples/boolean_t.output

+true

doc/examples/cbegin.link

-<a target="_blank" href="https://wandbox.org/permlink/hxcSxCPPLHpZMxjS"><b>online</b></a>
\ No newline at end of file

doc/examples/cend.link

-<a target="_blank" href="https://wandbox.org/permlink/xbnldrrN05tKIOEv"><b>online</b></a>
\ No newline at end of file

doc/examples/clear.link

-<a target="_blank" href="https://wandbox.org/permlink/gDQPYFxMrvD7RK4z"><b>online</b></a>
\ No newline at end of file

doc/examples/contains.link

-<a target="_blank" href="https://wandbox.org/permlink/vVY4F4xKC3v6pG6F"><b>online</b></a>
\ No newline at end of file

doc/examples/contains_json_pointer.link

-<a target="_blank" href="https://wandbox.org/permlink/Q2GTzxF8NA10kVvD"><b>online</b></a>
\ No newline at end of file

doc/examples/count.link

-<a target="_blank" href="https://wandbox.org/permlink/6LRjg1bqwchPUoDx"><b>online</b></a>
\ No newline at end of file

doc/examples/crbegin.link

-<a target="_blank" href="https://wandbox.org/permlink/JMDd9jiP0flRKJ6C"><b>online</b></a>
\ No newline at end of file

doc/examples/crend.link

-<a target="_blank" href="https://wandbox.org/permlink/HdlqwPk8bDfrZ4AE"><b>online</b></a>
\ No newline at end of file

doc/examples/diagnostics_extended.link

-<a target="_blank" href="https://wandbox.org/permlink/pbz3ULoJ4maRnV8N"><b>online</b></a>
\ No newline at end of file

doc/examples/diagnostics_standard.link

-<a target="_blank" href="https://wandbox.org/permlink/fWfQhHzG03P6PAcC"><b>online</b></a>
\ No newline at end of file

doc/examples/diff.link

-<a target="_blank" href="https://wandbox.org/permlink/GHVHgDpT5vx0KMPD"><b>online</b></a>
\ No newline at end of file

doc/examples/dump.link

-<a target="_blank" href="https://wandbox.org/permlink/DyMiKrkKMwd3R7OU"><b>online</b></a>
\ No newline at end of file

doc/examples/emplace.link

-<a target="_blank" href="https://wandbox.org/permlink/p9P3Ph8mdxMON6SY"><b>online</b></a>
\ No newline at end of file

doc/examples/emplace_back.link

-<a target="_blank" href="https://wandbox.org/permlink/yMxKrJfRedlFygJD"><b>online</b></a>
\ No newline at end of file

doc/examples/empty.link

-<a target="_blank" href="https://wandbox.org/permlink/zaexgkNdH3HYJm8D"><b>online</b></a>
\ No newline at end of file

doc/examples/end.link

-<a target="_blank" href="https://wandbox.org/permlink/eQ0YI8wWcMIHtBCS"><b>online</b></a>
\ No newline at end of file

doc/examples/erase__IteratorType.link

-<a target="_blank" href="https://wandbox.org/permlink/SD62jUgeIuudweZu"><b>online</b></a>
\ No newline at end of file

doc/examples/erase__IteratorType_IteratorType.link

-<a target="_blank" href="https://wandbox.org/permlink/gG3bN97HOF04Xw6S"><b>online</b></a>
\ No newline at end of file

doc/examples/erase__key_type.link

-<a target="_blank" href="https://wandbox.org/permlink/WSnobkZJZHUPUIRF"><b>online</b></a>
\ No newline at end of file

doc/examples/erase__size_type.link

-<a target="_blank" href="https://wandbox.org/permlink/GGoqGtqEzxAsAKnI"><b>online</b></a>
\ No newline at end of file

doc/examples/exception.link

-<a target="_blank" href="https://wandbox.org/permlink/vky6QCTCqtUnNVlD"><b>online</b></a>
\ No newline at end of file

doc/examples/find__key_type.link

-<a target="_blank" href="https://wandbox.org/permlink/aQjZSjuuDUxXQCjJ"><b>online</b></a>
\ No newline at end of file

doc/examples/flatten.link

-<a target="_blank" href="https://wandbox.org/permlink/moO4IdryeGS8QmKo"><b>online</b></a>
\ No newline at end of file

doc/examples/from_bson.cpp

@@ -7,11 +7,11 @@ using json = nlohmann::json;
 int main()
 {
     // create byte vector
-    std::vector<uint8_t> v = {0x1b, 0x00, 0x00, 0x00, 0x08, 0x63, 0x6f, 0x6d,
-                              0x70, 0x61, 0x63, 0x74, 0x00, 0x01, 0x10, 0x73,
-                              0x63, 0x68, 0x65, 0x6d, 0x61, 0x00, 0x00, 0x00,
-                              0x00, 0x00, 0x00
-                             };
+    std::vector<std::uint8_t> v = {0x1b, 0x00, 0x00, 0x00, 0x08, 0x63, 0x6f, 0x6d,
+                                   0x70, 0x61, 0x63, 0x74, 0x00, 0x01, 0x10, 0x73,
+                                   0x63, 0x68, 0x65, 0x6d, 0x61, 0x00, 0x00, 0x00,
+                                   0x00, 0x00, 0x00
+                                  };
 
     // deserialize it with BSON
     json j = json::from_bson(v);

doc/examples/from_bson.link

-<a target="_blank" href="https://wandbox.org/permlink/Q7O1liz5QrgQynqQ"><b>online</b></a>
\ No newline at end of file

doc/examples/from_cbor.cpp

@@ -7,10 +7,10 @@ using json = nlohmann::json;
 int main()
 {
     // create byte vector
-    std::vector<uint8_t> v = {0xa2, 0x67, 0x63, 0x6f, 0x6d, 0x70, 0x61, 0x63,
-                              0x74, 0xf5, 0x66, 0x73, 0x63, 0x68, 0x65, 0x6d,
-                              0x61, 0x00
-                             };
+    std::vector<std::uint8_t> v = {0xa2, 0x67, 0x63, 0x6f, 0x6d, 0x70, 0x61, 0x63,
+                                   0x74, 0xf5, 0x66, 0x73, 0x63, 0x68, 0x65, 0x6d,
+                                   0x61, 0x00
+                                  };
 
     // deserialize it with CBOR
     json j = json::from_cbor(v);

doc/examples/from_cbor.link

-<a target="_blank" href="https://wandbox.org/permlink/AjdbchxfTsN9PHCL"><b>online</b></a>
\ No newline at end of file

doc/examples/from_msgpack.cpp

@@ -7,10 +7,10 @@ using json = nlohmann::json;
 int main()
 {
     // create byte vector
-    std::vector<uint8_t> v = {0x82, 0xa7, 0x63, 0x6f, 0x6d, 0x70, 0x61, 0x63,
-                              0x74, 0xc3, 0xa6, 0x73, 0x63, 0x68, 0x65, 0x6d,
-                              0x61, 0x00
-                             };
+    std::vector<std::uint8_t> v = {0x82, 0xa7, 0x63, 0x6f, 0x6d, 0x70, 0x61, 0x63,
+                                   0x74, 0xc3, 0xa6, 0x73, 0x63, 0x68, 0x65, 0x6d,
+                                   0x61, 0x00
+                                  };
 
     // deserialize it with MessagePack
     json j = json::from_msgpack(v);

doc/examples/from_msgpack.link

-<a target="_blank" href="https://wandbox.org/permlink/TdJfkKx0RAH5NB62"><b>online</b></a>
\ No newline at end of file

doc/examples/from_ubjson.cpp

@@ -7,10 +7,10 @@ using json = nlohmann::json;
 int main()
 {
     // create byte vector
-    std::vector<uint8_t> v = {0x7B, 0x69, 0x07, 0x63, 0x6F, 0x6D, 0x70, 0x61,
-                              0x63, 0x74, 0x54, 0x69, 0x06, 0x73, 0x63, 0x68,
-                              0x65, 0x6D, 0x61, 0x69, 0x00, 0x7D
-                             };
+    std::vector<std::uint8_t> v = {0x7B, 0x69, 0x07, 0x63, 0x6F, 0x6D, 0x70, 0x61,
+                                   0x63, 0x74, 0x54, 0x69, 0x06, 0x73, 0x63, 0x68,
+                                   0x65, 0x6D, 0x61, 0x69, 0x00, 0x7D
+                                  };
 
     // deserialize it with UBJSON
     json j = json::from_ubjson(v);

doc/examples/from_ubjson.link

-<a target="_blank" href="https://wandbox.org/permlink/GG9VzOZh1MDeTSsK"><b>online</b></a>
\ No newline at end of file

doc/examples/front.link

-<a target="_blank" href="https://wandbox.org/permlink/LtqaiI6oRplSg0KI"><b>online</b></a>
\ No newline at end of file

doc/examples/get__PointerType.link

-<a target="_blank" href="https://wandbox.org/permlink/ddVSXnbULrNrCbRs"><b>online</b></a>
\ No newline at end of file

doc/examples/get__ValueType_const.link

-<a target="_blank" href="https://wandbox.org/permlink/QjVgxx0bwbKuE9HI"><b>online</b></a>
\ No newline at end of file

doc/examples/get_binary.cpp

+#include <iostream>
+#include <nlohmann/json.hpp>
+
+using json = nlohmann::json;
+
+int main()
+{
+    // create a binary vector
+    std::vector<std::uint8_t> vec = {0xCA, 0xFE, 0xBA, 0xBE};
+
+    // create a binary JSON value with subtype 42
+    json j = json::binary(vec, 42);
+
+    // output type and subtype
+    std::cout << "type: " << j.type_name() << ", subtype: " << j.get_binary().subtype() << std::endl;
+}

doc/examples/get_binary.output

+type: binary, subtype: 42

doc/examples/get_ptr.link

-<a target="_blank" href="https://wandbox.org/permlink/eA1KrytMlQl1SURe"><b>online</b></a>
\ No newline at end of file

doc/examples/get_ref.link

-<a target="_blank" href="https://wandbox.org/permlink/jVaWWe3kAjKKn99V"><b>online</b></a>
\ No newline at end of file

doc/examples/get_to.link

-<a target="_blank" href="https://wandbox.org/permlink/UvdMlXdPnXFUq1lJ"><b>online</b></a>
\ No newline at end of file

doc/examples/insert.link

-<a target="_blank" href="https://wandbox.org/permlink/N1nlz2liDCmBn40h"><b>online</b></a>
\ No newline at end of file

doc/examples/insert__count.link

-<a target="_blank" href="https://wandbox.org/permlink/eoHfSYf04soRkOto"><b>online</b></a>
\ No newline at end of file

doc/examples/insert__ilist.link

-<a target="_blank" href="https://wandbox.org/permlink/oNhgDq5ejDl5RyqW"><b>online</b></a>
\ No newline at end of file

doc/examples/insert__range.link

-<a target="_blank" href="https://wandbox.org/permlink/LdmbgtdndQw81wQU"><b>online</b></a>
\ No newline at end of file

doc/examples/insert__range_object.link

-<a target="_blank" href="https://wandbox.org/permlink/kp99ButEWpuNxPbq"><b>online</b></a>
\ No newline at end of file

doc/examples/invalid_iterator.link

-<a target="_blank" href="https://wandbox.org/permlink/oUdIj3ZSbg7UCIuz"><b>online</b></a>
\ No newline at end of file

doc/examples/is_array.link

-<a target="_blank" href="https://wandbox.org/permlink/2ZgSEJ7UBJ9d4H6b"><b>online</b></a>
\ No newline at end of file

doc/examples/is_binary.link

-<a target="_blank" href="https://wandbox.org/permlink/to5RDM1vhrDMUfVv"><b>online</b></a>
\ No newline at end of file

doc/examples/is_boolean.link

-<a target="_blank" href="https://wandbox.org/permlink/20OXaCBWTM1dhFmv"><b>online</b></a>
\ No newline at end of file

doc/examples/is_discarded.link

-<a target="_blank" href="https://wandbox.org/permlink/rTNvfIpTXdFXIe20"><b>online</b></a>
\ No newline at end of file

doc/examples/is_null.link

-<a target="_blank" href="https://wandbox.org/permlink/GCQOJn7fTbm6kPBo"><b>online</b></a>
\ No newline at end of file

doc/examples/is_number.link

-<a target="_blank" href="https://wandbox.org/permlink/guySOWaTCKiXcueC"><b>online</b></a>
\ No newline at end of file

doc/examples/is_number_float.link

-<a target="_blank" href="https://wandbox.org/permlink/371XB9Jo3cwHDIBc"><b>online</b></a>
\ No newline at end of file

doc/examples/is_number_integer.link

-<a target="_blank" href="https://wandbox.org/permlink/qzb1GYNdSbeVRamt"><b>online</b></a>
\ No newline at end of file

doc/examples/is_number_unsigned.link

-<a target="_blank" href="https://wandbox.org/permlink/wcfMOOVBjQMZ6iQi"><b>online</b></a>
\ No newline at end of file

doc/examples/is_object.link

-<a target="_blank" href="https://wandbox.org/permlink/I9UET2tNOZLYKvf9"><b>online</b></a>
\ No newline at end of file

doc/examples/is_primitive.link

-<a target="_blank" href="https://wandbox.org/permlink/wdEBCnH75A2tWTPp"><b>online</b></a>
\ No newline at end of file

doc/examples/is_string.link

-<a target="_blank" href="https://wandbox.org/permlink/Lcz1noVRzYcB7vXP"><b>online</b></a>
\ No newline at end of file

doc/examples/is_structured.link

-<a target="_blank" href="https://wandbox.org/permlink/1eYTBWunXeo3dEXD"><b>online</b></a>
\ No newline at end of file

doc/examples/items.link

-<a target="_blank" href="https://wandbox.org/permlink/ScW4gbehjRyjHyPZ"><b>online</b></a>
\ No newline at end of file

doc/examples/iterator_wrapper.cpp

@@ -9,6 +9,12 @@ int main()
     json j_object = {{"one", 1}, {"two", 2}};
     json j_array = {1, 2, 4, 8, 16};
 
+    //////////////////////////////////////////////////////////////////////////
+    // The static function iterator_wrapper was deprecated in version 3.1.0
+    // and will be removed in version 4.0.0. Please replace all occurrences
+    // of iterator_wrapper(j) with j.items().
+    //////////////////////////////////////////////////////////////////////////
+
     // example for an object
     for (auto& x : json::iterator_wrapper(j_object))
     {