lib/json
1
0
Fork 0
mirror of https://github.com/nlohmann/json.git synced 2025-07-12 09:21:42 +03:00
Code Activity

improved documentation

Browse Source
This commit is contained in:
Niels
2016-07-25 16:06:13 +02:00
parent 369671f028
commit d08e013dd0
5 changed files with 93 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
src/json.hpp.re2c
View File

@ -974,7 +974,9 @@ class basic_json
@since version 1.0.0
*/
using parser_callback_t = std::function<bool(int depth, parse_event_t event, basic_json& parsed)>;
using parser_callback_t = std::function<bool(int depth,
parse_event_t event,
basic_json& parsed)>;
//////////////////
@ -3716,6 +3718,21 @@ class basic_json
/*!
@brief access specified object element via JSON Pointer with default value
Returns either a copy of an object's element at the specified key @a key
or a given default value if no element with key @a key exists.
The function is basically equivalent to executing
@code {.cpp}
try {
return at(ptr);
} catch(std::out_of_range) {
return default_value;
}
@endcode
@note Unlike @ref at(const json_pointer&), this function does not throw
if the given key @a key was not found.
@param[in] ptr a JSON pointer to the element to access
@param[in] default_value the value to return if @a ptr found no value
@ -3724,6 +3741,19 @@ class basic_json
JSON arrays. Note the type of the expected value at @a key and the default
value @a default_value must be compatible.
@return copy of the element at key @a key or @a default_value if @a key
is not found
@throw std::domain_error if JSON is not an object; example: `"cannot use
value() with null"`
@complexity Logarithmic in the size of the container.
@liveexample{The example below shows how object elements can be queried
with a default value.,basic_json__value_ptr}
@sa @ref operator[](const json_ptr&) for unchecked access by reference
@since version 2.0.2
*/
template <class ValueType, typename