📝 document less-than comparability

This commit is contained in:
Niels Lohmann 2021-05-03 20:20:52 +02:00
parent 08185548cc
commit 12c0bc4c9e
No known key found for this signature in database
GPG Key ID: 7F3CEA63AE251B69
7 changed files with 14 additions and 10 deletions

View File

@ -23,8 +23,8 @@ const_reference at(const json_pointer& ptr) const;
## Template parameters
`KeyT`
: A type for an object key other than `basic_json::json_pointer`. This can also be a string literal or a string view
(C++17).
: A type for an object key other than `basic_json::json_pointer` that is less-than comparable with `string_t`. This
can also be a string literal or a string view (C++17).
## Parameters

View File

@ -11,8 +11,8 @@ value is not an object, `#!cpp false` is returned.
## Template parameters
`KeyT`
: A type for an object key other than `basic_json::json_pointer`. This can also be a string literal or a string view
(C++17).
: A type for an object key other than `basic_json::json_pointer` that is less-than comparable with `string_t`. This
can also be a string literal or a string view (C++17).
## Parameters

View File

@ -11,7 +11,8 @@ always be `0` (`key` was not found) or `1` (`key` was found).
## Template parameters
`KeyT`
: A type for an object key. This can also be a string literal or a string view (C++17).
: A type for an object key that is less-than comparable with `string_t`. This can also be a string literal or a string
view (C++17).
## Parameters

View File

@ -35,7 +35,8 @@ void erase(const size_type idx);
## Template parameters
`KeyT`
: A type convertible to an object key. This can also be a string literal or a string view (C++17).
: A type for an object key that is less-than comparable with `string_t`. This can also be a string literal or a string
view (C++17).
## Parameters

View File

@ -14,7 +14,8 @@ object, `end()` is returned.
## Template parameters
`KeyT`
: A type for an object key. This can also be a string literal or a string view (C++17).
: A type for an object key that is less-than comparable with `string_t`. This can also be a string literal or a string
view (C++17).
## Parameters

View File

@ -23,8 +23,8 @@ const_reference operator[](const json_pointer& ptr) const;
## Template parameters
`KeyT`
: A type for an object key other than `basic_json::json_pointer`. This can also be a string literal or a string view
(C++17).
: A type for an object key other than `basic_json::json_pointer` that is less-than comparable with `string_t`. This
can also be a string literal or a string view (C++17).
## Parameters

View File

@ -42,7 +42,8 @@ Unlike [`operator[]`](operator[].md), this function does not implicitly add an e
## Template parameters
`KeyType`
: A type for an object key. This can also be a string literal or a string view (C++17).
: A type for an object key that is less-than comparable with `string_t`. This can also be a string literal or a string
view (C++17).
`ValueType`
: type compatible to JSON values, for instance `#!cpp int` for JSON integer numbers, `#!cpp bool` for JSON booleans,
or `#!cpp std::vector` types for JSON arrays. Note the type of the expected value at `key`/`ptr` and the default