Unverified Commit a8e86ba9 authored by Niels Lohmann's avatar Niels Lohmann Committed by GitHub

📝 improve documentation InputType and IteratorType (#3246)

parent 9e89c2fd
...@@ -32,10 +32,14 @@ Unlike the [`parse`](parse.md) function, this function neither throws an excepti ...@@ -32,10 +32,14 @@ Unlike the [`parse`](parse.md) function, this function neither throws an excepti
- a `FILE` pointer - a `FILE` pointer
- a C-style array of characters - a C-style array of characters
- a pointer to a null-terminated string of single byte characters - a pointer to a null-terminated string of single byte characters
- a `std::string`
- an object `obj` for which `begin(obj)` and `end(obj)` produces a valid pair of iterators. - an object `obj` for which `begin(obj)` and `end(obj)` produces a valid pair of iterators.
`IteratorType` `IteratorType`
: a compatible iterator type : a compatible iterator type, for instance.
- a pair of `std::string::iterator` or `std::vector<std::uint8_t>::iterator`
- a pair of pointers such as `ptr` and `ptr + len`
## Parameters ## Parameters
......
...@@ -31,6 +31,7 @@ static basic_json parse(IteratorType first, IteratorType last, ...@@ -31,6 +31,7 @@ static basic_json parse(IteratorType first, IteratorType last,
- a `FILE` pointer - a `FILE` pointer
- a C-style array of characters - a C-style array of characters
- a pointer to a null-terminated string of single byte characters - a pointer to a null-terminated string of single byte characters
- a `std::string`
- an object `obj` for which `begin(obj)` and `end(obj)` produces a valid pair of iterators. - an object `obj` for which `begin(obj)` and `end(obj)` produces a valid pair of iterators.
`IteratorType` `IteratorType`
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment