1
0
mirror of https://github.com/nlohmann/json.git synced 2025-07-29 23:01:16 +03:00

📝 add more API documentation

This commit is contained in:
Niels Lohmann
2020-08-13 15:03:28 +02:00
parent ce6adc447a
commit dd2fb3b454
13 changed files with 624 additions and 19 deletions

View File

@ -9,11 +9,8 @@ static basic_json parse(InputType&& i,
const bool ignore_comments = false);
// (2)
static basic_json parse(iterator first, iterator last,
const parser_callback_t cb = nullptr,
const bool allow_exceptions = true,
const bool ignore_comments = false);
static basic_json parse(const_iterator first, const_iterator last,
template<typename IteratorType>
static basic_json parse(IteratorType first, IteratorType last,
const parser_callback_t cb = nullptr,
const bool allow_exceptions = true,
const bool ignore_comments = false);
@ -36,6 +33,9 @@ static basic_json parse(const_iterator first, const_iterator last,
- a pointer to a null-terminated string of single byte characters
- an object `obj` for which `begin(obj)` and `end(obj)` produces a valid pair of iterators.
`IteratorType`
: a compatible iterator type
## Parameters
`i` (in)