From 25f56ff2076aa7fd3e275e92db4eb15a5f111894 Mon Sep 17 00:00:00 2001 From: Niels Lohmann Date: Tue, 20 Mar 2018 19:22:18 +0100 Subject: [PATCH] :memo: updated documentation --- include/nlohmann/json.hpp | 37 ++++++++++++++++++-------------- single_include/nlohmann/json.hpp | 37 ++++++++++++++++++-------------- 2 files changed, 42 insertions(+), 32 deletions(-) diff --git a/include/nlohmann/json.hpp b/include/nlohmann/json.hpp index 393fa2ea..ff2f7f34 100644 --- a/include/nlohmann/json.hpp +++ b/include/nlohmann/json.hpp @@ -6629,14 +6629,15 @@ class basic_json @sa http://cbor.io @sa @ref to_cbor(const basic_json&) for the analogous serialization - @sa @ref from_msgpack(detail::input_adapter, const bool) for the + @sa @ref from_msgpack(detail::input_adapter, const bool, const bool) for the related MessagePack format - @sa @ref from_ubjson(detail::input_adapter, const bool) for the related - UBJSON format + @sa @ref from_ubjson(detail::input_adapter, const bool, const bool) for the + related UBJSON format @since version 2.0.9; parameter @a start_index since 2.1.1; changed to consume input adapters, removed start_index parameter, and added - @a strict parameter since 3.0.0 + @a strict parameter since 3.0.0; added @allow_exceptions parameter + since 3.2.0 */ static basic_json from_cbor(detail::input_adapter i, const bool strict = true, @@ -6649,7 +6650,7 @@ class basic_json } /*! - @copydoc from_cbor(detail::input_adapter, const bool) + @copydoc from_cbor(detail::input_adapter, const bool, const bool) */ template::value, int> = 0> @@ -6731,14 +6732,15 @@ class basic_json @sa http://msgpack.org @sa @ref to_msgpack(const basic_json&) for the analogous serialization - @sa @ref from_cbor(detail::input_adapter, const bool) for the related CBOR - format - @sa @ref from_ubjson(detail::input_adapter, const bool) for the related - UBJSON format + @sa @ref from_cbor(detail::input_adapter, const bool, const bool) for the + related CBOR format + @sa @ref from_ubjson(detail::input_adapter, const bool, const bool) for + the related UBJSON format @since version 2.0.9; parameter @a start_index since 2.1.1; changed to consume input adapters, removed start_index parameter, and added - @a strict parameter since 3.0.0 + @a strict parameter since 3.0.0; added @allow_exceptions parameter + since 3.2.0 */ static basic_json from_msgpack(detail::input_adapter i, const bool strict = true, @@ -6751,7 +6753,7 @@ class basic_json } /*! - @copydoc from_msgpack(detail::input_adapter, const bool) + @copydoc from_msgpack(detail::input_adapter, const bool, const bool) */ template::value, int> = 0> @@ -6815,12 +6817,12 @@ class basic_json @sa http://ubjson.org @sa @ref to_ubjson(const basic_json&, const bool, const bool) for the analogous serialization - @sa @ref from_cbor(detail::input_adapter, const bool) for the related CBOR - format - @sa @ref from_msgpack(detail::input_adapter, const bool) for the related - MessagePack format + @sa @ref from_cbor(detail::input_adapter, const bool, const bool) for the + related CBOR format + @sa @ref from_msgpack(detail::input_adapter, const bool, const bool) for + the related MessagePack format - @since version 3.1.0 + @since version 3.1.0; added @allow_exceptions parameter since 3.2.0 */ static basic_json from_ubjson(detail::input_adapter i, const bool strict = true, @@ -6832,6 +6834,9 @@ class basic_json return res ? result : basic_json(value_t::discarded); } + /*! + @copydoc from_ubjson(detail::input_adapter, const bool, const bool) + */ template::value, int> = 0> static basic_json from_ubjson(A1 && a1, A2 && a2, diff --git a/single_include/nlohmann/json.hpp b/single_include/nlohmann/json.hpp index 57eba455..67af8de1 100644 --- a/single_include/nlohmann/json.hpp +++ b/single_include/nlohmann/json.hpp @@ -17378,14 +17378,15 @@ class basic_json @sa http://cbor.io @sa @ref to_cbor(const basic_json&) for the analogous serialization - @sa @ref from_msgpack(detail::input_adapter, const bool) for the + @sa @ref from_msgpack(detail::input_adapter, const bool, const bool) for the related MessagePack format - @sa @ref from_ubjson(detail::input_adapter, const bool) for the related - UBJSON format + @sa @ref from_ubjson(detail::input_adapter, const bool, const bool) for the + related UBJSON format @since version 2.0.9; parameter @a start_index since 2.1.1; changed to consume input adapters, removed start_index parameter, and added - @a strict parameter since 3.0.0 + @a strict parameter since 3.0.0; added @allow_exceptions parameter + since 3.2.0 */ static basic_json from_cbor(detail::input_adapter i, const bool strict = true, @@ -17398,7 +17399,7 @@ class basic_json } /*! - @copydoc from_cbor(detail::input_adapter, const bool) + @copydoc from_cbor(detail::input_adapter, const bool, const bool) */ template::value, int> = 0> @@ -17480,14 +17481,15 @@ class basic_json @sa http://msgpack.org @sa @ref to_msgpack(const basic_json&) for the analogous serialization - @sa @ref from_cbor(detail::input_adapter, const bool) for the related CBOR - format - @sa @ref from_ubjson(detail::input_adapter, const bool) for the related - UBJSON format + @sa @ref from_cbor(detail::input_adapter, const bool, const bool) for the + related CBOR format + @sa @ref from_ubjson(detail::input_adapter, const bool, const bool) for + the related UBJSON format @since version 2.0.9; parameter @a start_index since 2.1.1; changed to consume input adapters, removed start_index parameter, and added - @a strict parameter since 3.0.0 + @a strict parameter since 3.0.0; added @allow_exceptions parameter + since 3.2.0 */ static basic_json from_msgpack(detail::input_adapter i, const bool strict = true, @@ -17500,7 +17502,7 @@ class basic_json } /*! - @copydoc from_msgpack(detail::input_adapter, const bool) + @copydoc from_msgpack(detail::input_adapter, const bool, const bool) */ template::value, int> = 0> @@ -17564,12 +17566,12 @@ class basic_json @sa http://ubjson.org @sa @ref to_ubjson(const basic_json&, const bool, const bool) for the analogous serialization - @sa @ref from_cbor(detail::input_adapter, const bool) for the related CBOR - format - @sa @ref from_msgpack(detail::input_adapter, const bool) for the related - MessagePack format + @sa @ref from_cbor(detail::input_adapter, const bool, const bool) for the + related CBOR format + @sa @ref from_msgpack(detail::input_adapter, const bool, const bool) for + the related MessagePack format - @since version 3.1.0 + @since version 3.1.0; added @allow_exceptions parameter since 3.2.0 */ static basic_json from_ubjson(detail::input_adapter i, const bool strict = true, @@ -17581,6 +17583,9 @@ class basic_json return res ? result : basic_json(value_t::discarded); } + /*! + @copydoc from_ubjson(detail::input_adapter, const bool, const bool) + */ template::value, int> = 0> static basic_json from_ubjson(A1 && a1, A2 && a2,