📝 improve documentation InputType and IteratorType (#3246)

pull/3247/head
Niels Lohmann 2022-01-04 15:02:39 +01:00 committed by GitHub
parent 9e89c2fdb5
commit a8e86ba948
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 6 additions and 1 deletions

View File

@ -32,10 +32,14 @@ Unlike the [`parse`](parse.md) function, this function neither throws an excepti
- a `FILE` pointer
- a C-style array of 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.
`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

View File

@ -31,6 +31,7 @@ static basic_json parse(IteratorType first, IteratorType last,
- a `FILE` pointer
- a C-style array of 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.
`IteratorType`