📝 document less-than comparability

parent 08185548
...@@ -23,8 +23,8 @@ const_reference at(const json_pointer& ptr) const; ...@@ -23,8 +23,8 @@ const_reference at(const json_pointer& ptr) const;
## Template parameters ## Template parameters
`KeyT` `KeyT`
: A type for an object key other than `basic_json::json_pointer`. This can also be a string literal or a string view : A type for an object key other than `basic_json::json_pointer` that is less-than comparable with `string_t`. This
(C++17). can also be a string literal or a string view (C++17).
## Parameters ## Parameters
......
...@@ -11,8 +11,8 @@ value is not an object, `#!cpp false` is returned. ...@@ -11,8 +11,8 @@ value is not an object, `#!cpp false` is returned.
## Template parameters ## Template parameters
`KeyT` `KeyT`
: A type for an object key other than `basic_json::json_pointer`. This can also be a string literal or a string view : A type for an object key other than `basic_json::json_pointer` that is less-than comparable with `string_t`. This
(C++17). can also be a string literal or a string view (C++17).
## Parameters ## Parameters
......
...@@ -11,7 +11,8 @@ always be `0` (`key` was not found) or `1` (`key` was found). ...@@ -11,7 +11,8 @@ always be `0` (`key` was not found) or `1` (`key` was found).
## Template parameters ## Template parameters
`KeyT` `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 ## Parameters
......
...@@ -35,7 +35,8 @@ void erase(const size_type idx); ...@@ -35,7 +35,8 @@ void erase(const size_type idx);
## Template parameters ## Template parameters
`KeyT` `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 ## Parameters
......
...@@ -14,7 +14,8 @@ object, `end()` is returned. ...@@ -14,7 +14,8 @@ object, `end()` is returned.
## Template parameters ## Template parameters
`KeyT` `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 ## Parameters
......
...@@ -23,8 +23,8 @@ const_reference operator[](const json_pointer& ptr) const; ...@@ -23,8 +23,8 @@ const_reference operator[](const json_pointer& ptr) const;
## Template parameters ## Template parameters
`KeyT` `KeyT`
: A type for an object key other than `basic_json::json_pointer`. This can also be a string literal or a string view : A type for an object key other than `basic_json::json_pointer` that is less-than comparable with `string_t`. This
(C++17). can also be a string literal or a string view (C++17).
## Parameters ## Parameters
......
...@@ -42,7 +42,8 @@ Unlike [`operator[]`](operator[].md), this function does not implicitly add an e ...@@ -42,7 +42,8 @@ Unlike [`operator[]`](operator[].md), this function does not implicitly add an e
## Template parameters ## Template parameters
`KeyType` `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` `ValueType`
: type compatible to JSON values, for instance `#!cpp int` for JSON integer numbers, `#!cpp bool` for JSON booleans, : 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 or `#!cpp std::vector` types for JSON arrays. Note the type of the expected value at `key`/`ptr` and the default
......
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