mirror of
https://github.com/nlohmann/json.git
synced 2025-07-29 23:01:16 +03:00
📝 add more API documentation
This commit is contained in:
@ -4,13 +4,11 @@
|
||||
basic_json unflatten() const;
|
||||
```
|
||||
|
||||
The function restores the arbitrary nesting of a JSON value that has been
|
||||
flattened before using the [`flatten()`](flatten.md) function. The JSON value must
|
||||
meet certain constraints:
|
||||
The function restores the arbitrary nesting of a JSON value that has been flattened before using the
|
||||
[`flatten()`](flatten.md) function. The JSON value must meet certain constraints:
|
||||
|
||||
1. The value must be an object.
|
||||
2. The keys must be JSON pointers (see
|
||||
[RFC 6901](https://tools.ietf.org/html/rfc6901))
|
||||
2. The keys must be JSON pointers (see [RFC 6901](https://tools.ietf.org/html/rfc6901))
|
||||
3. The mapped values must be primitive JSON types.
|
||||
|
||||
## Return value
|
||||
@ -34,17 +32,15 @@ Linear in the size the JSON value.
|
||||
|
||||
## Notes
|
||||
|
||||
Empty objects and arrays are flattened by [`flatten()`](flatten.md) to `#!json null`
|
||||
values and can not unflattened to their original type. Apart from
|
||||
this example, for a JSON value `j`, the following is always true:
|
||||
Empty objects and arrays are flattened by [`flatten()`](flatten.md) to `#!json null` values and can not unflattened to
|
||||
their original type. Apart from this example, for a JSON value `j`, the following is always true:
|
||||
`#!cpp j == j.flatten().unflatten()`.
|
||||
|
||||
## Example
|
||||
|
||||
??? example
|
||||
|
||||
The following code shows how a flattened JSON object is
|
||||
unflattened into the original nested JSON object.
|
||||
The following code shows how a flattened JSON object is unflattened into the original nested JSON object.
|
||||
|
||||
```cpp
|
||||
--8<-- "examples/unflatten.cpp"
|
||||
|
Reference in New Issue
Block a user