📝 updated documentation

This commit is contained in:
Niels Lohmann 2018-03-20 19:22:18 +01:00
parent 99ecca55c4
commit 25f56ff207
No known key found for this signature in database
GPG key ID: 7F3CEA63AE251B69
2 changed files with 42 additions and 32 deletions

View file

@ -6629,14 +6629,15 @@ class basic_json
@sa http://cbor.io @sa http://cbor.io
@sa @ref to_cbor(const basic_json&) for the analogous serialization @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 related MessagePack format
@sa @ref from_ubjson(detail::input_adapter, const bool) for the related @sa @ref from_ubjson(detail::input_adapter, const bool, const bool) for the
UBJSON format related UBJSON format
@since version 2.0.9; parameter @a start_index since 2.1.1; changed to @since version 2.0.9; parameter @a start_index since 2.1.1; changed to
consume input adapters, removed start_index parameter, and added 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, static basic_json from_cbor(detail::input_adapter i,
const bool strict = true, 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<typename A1, typename A2, template<typename A1, typename A2,
detail::enable_if_t<std::is_constructible<detail::input_adapter, A1, A2>::value, int> = 0> detail::enable_if_t<std::is_constructible<detail::input_adapter, A1, A2>::value, int> = 0>
@ -6731,14 +6732,15 @@ class basic_json
@sa http://msgpack.org @sa http://msgpack.org
@sa @ref to_msgpack(const basic_json&) for the analogous serialization @sa @ref to_msgpack(const basic_json&) for the analogous serialization
@sa @ref from_cbor(detail::input_adapter, const bool) for the related CBOR @sa @ref from_cbor(detail::input_adapter, const bool, const bool) for the
format related CBOR format
@sa @ref from_ubjson(detail::input_adapter, const bool) for the related @sa @ref from_ubjson(detail::input_adapter, const bool, const bool) for
UBJSON format the related UBJSON format
@since version 2.0.9; parameter @a start_index since 2.1.1; changed to @since version 2.0.9; parameter @a start_index since 2.1.1; changed to
consume input adapters, removed start_index parameter, and added 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, static basic_json from_msgpack(detail::input_adapter i,
const bool strict = true, 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<typename A1, typename A2, template<typename A1, typename A2,
detail::enable_if_t<std::is_constructible<detail::input_adapter, A1, A2>::value, int> = 0> detail::enable_if_t<std::is_constructible<detail::input_adapter, A1, A2>::value, int> = 0>
@ -6815,12 +6817,12 @@ class basic_json
@sa http://ubjson.org @sa http://ubjson.org
@sa @ref to_ubjson(const basic_json&, const bool, const bool) for the @sa @ref to_ubjson(const basic_json&, const bool, const bool) for the
analogous serialization analogous serialization
@sa @ref from_cbor(detail::input_adapter, const bool) for the related CBOR @sa @ref from_cbor(detail::input_adapter, const bool, const bool) for the
format related CBOR format
@sa @ref from_msgpack(detail::input_adapter, const bool) for the related @sa @ref from_msgpack(detail::input_adapter, const bool, const bool) for
MessagePack format 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, static basic_json from_ubjson(detail::input_adapter i,
const bool strict = true, const bool strict = true,
@ -6832,6 +6834,9 @@ class basic_json
return res ? result : basic_json(value_t::discarded); return res ? result : basic_json(value_t::discarded);
} }
/*!
@copydoc from_ubjson(detail::input_adapter, const bool, const bool)
*/
template<typename A1, typename A2, template<typename A1, typename A2,
detail::enable_if_t<std::is_constructible<detail::input_adapter, A1, A2>::value, int> = 0> detail::enable_if_t<std::is_constructible<detail::input_adapter, A1, A2>::value, int> = 0>
static basic_json from_ubjson(A1 && a1, A2 && a2, static basic_json from_ubjson(A1 && a1, A2 && a2,

View file

@ -17378,14 +17378,15 @@ class basic_json
@sa http://cbor.io @sa http://cbor.io
@sa @ref to_cbor(const basic_json&) for the analogous serialization @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 related MessagePack format
@sa @ref from_ubjson(detail::input_adapter, const bool) for the related @sa @ref from_ubjson(detail::input_adapter, const bool, const bool) for the
UBJSON format related UBJSON format
@since version 2.0.9; parameter @a start_index since 2.1.1; changed to @since version 2.0.9; parameter @a start_index since 2.1.1; changed to
consume input adapters, removed start_index parameter, and added 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, static basic_json from_cbor(detail::input_adapter i,
const bool strict = true, 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<typename A1, typename A2, template<typename A1, typename A2,
detail::enable_if_t<std::is_constructible<detail::input_adapter, A1, A2>::value, int> = 0> detail::enable_if_t<std::is_constructible<detail::input_adapter, A1, A2>::value, int> = 0>
@ -17480,14 +17481,15 @@ class basic_json
@sa http://msgpack.org @sa http://msgpack.org
@sa @ref to_msgpack(const basic_json&) for the analogous serialization @sa @ref to_msgpack(const basic_json&) for the analogous serialization
@sa @ref from_cbor(detail::input_adapter, const bool) for the related CBOR @sa @ref from_cbor(detail::input_adapter, const bool, const bool) for the
format related CBOR format
@sa @ref from_ubjson(detail::input_adapter, const bool) for the related @sa @ref from_ubjson(detail::input_adapter, const bool, const bool) for
UBJSON format the related UBJSON format
@since version 2.0.9; parameter @a start_index since 2.1.1; changed to @since version 2.0.9; parameter @a start_index since 2.1.1; changed to
consume input adapters, removed start_index parameter, and added 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, static basic_json from_msgpack(detail::input_adapter i,
const bool strict = true, 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<typename A1, typename A2, template<typename A1, typename A2,
detail::enable_if_t<std::is_constructible<detail::input_adapter, A1, A2>::value, int> = 0> detail::enable_if_t<std::is_constructible<detail::input_adapter, A1, A2>::value, int> = 0>
@ -17564,12 +17566,12 @@ class basic_json
@sa http://ubjson.org @sa http://ubjson.org
@sa @ref to_ubjson(const basic_json&, const bool, const bool) for the @sa @ref to_ubjson(const basic_json&, const bool, const bool) for the
analogous serialization analogous serialization
@sa @ref from_cbor(detail::input_adapter, const bool) for the related CBOR @sa @ref from_cbor(detail::input_adapter, const bool, const bool) for the
format related CBOR format
@sa @ref from_msgpack(detail::input_adapter, const bool) for the related @sa @ref from_msgpack(detail::input_adapter, const bool, const bool) for
MessagePack format 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, static basic_json from_ubjson(detail::input_adapter i,
const bool strict = true, const bool strict = true,
@ -17581,6 +17583,9 @@ class basic_json
return res ? result : basic_json(value_t::discarded); return res ? result : basic_json(value_t::discarded);
} }
/*!
@copydoc from_ubjson(detail::input_adapter, const bool, const bool)
*/
template<typename A1, typename A2, template<typename A1, typename A2,
detail::enable_if_t<std::is_constructible<detail::input_adapter, A1, A2>::value, int> = 0> detail::enable_if_t<std::is_constructible<detail::input_adapter, A1, A2>::value, int> = 0>
static basic_json from_ubjson(A1 && a1, A2 && a2, static basic_json from_ubjson(A1 && a1, A2 && a2,