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

📝 add more API documentation

Browse Source
This commit is contained in:
Niels Lohmann
2020-08-12 14:29:25 +02:00
parent fe89049aee
commit 874f49e945
22 changed files with 285 additions and 405 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
doc/mkdocs/docs/api/basic_json/object.md
View File

@ -4,9 +4,8 @@
static basic_json object(initializer_list_t init = {});
```
Creates a JSON object value from a given initializer list. The initializer
lists elements must be pairs, and their first elements must be strings. If
the initializer list is empty, the empty object `#!json {}` is created.
Creates a JSON object value from a given initializer list. The initializer lists elements must be pairs, and their first
elements must be strings. If the initializer list is empty, the empty object `#!json {}` is created.
## Parameters
@ -19,17 +18,14 @@ JSON object value
## Exceptions
Throws [`type_error.301`](../../home/exceptions.md#jsonexceptiontype_error301)
if `init` is not a list of pairs whose first
elements are strings. In this case, no object can be created. When such a
value is passed to `basic_json(initializer_list_t, bool, value_t)`,
an array would have been created from the passed initializer list `init`.
See example below.
Throws [`type_error.301`](../../home/exceptions.md#jsonexceptiontype_error301) if `init` is not a list of pairs whose
first elements are strings. In this case, no object can be created. When such a value is passed to
`basic_json(initializer_list_t, bool, value_t)`, an array would have been created from the passed initializer list
`init`. See example below.
## Exception safety
Strong guarantee: if an exception is thrown, there are no
changes in the JSON value.
Strong guarantee: if an exception is thrown, there are no changes in the JSON value.
## Complexity
@ -37,18 +33,15 @@ Linear in the size of `init`.
## Notes
This function is only added for symmetry reasons. In contrast to the
related function `array(initializer_list_t)`, there are
no cases which can only be expressed by this function. That is, any
initializer list `init` can also be passed to the initializer list
constructor `basic_json(initializer_list_t, bool, value_t)`.
This function is only added for symmetry reasons. In contrast to the related function `array(initializer_list_t)`, there
are no cases which can only be expressed by this function. That is, any initializer list `init` can also be passed to
the initializer list constructor `basic_json(initializer_list_t, bool, value_t)`.
## Examples
??? example
The following code shows an example for the `object`
function.
The following code shows an example for the `object` function.
```cpp
--8<-- "examples/object.cpp"