mirror of
https://github.com/nlohmann/json.git
synced 2025-07-28 12:02:00 +03:00
Consolidate documentation (#3071)
* 🔥 consolidate documentation * ♻️ overwork std specializations * 🚚 move images files to mkdocs * ♻️ fix URLs * 🔧 tweak MkDocs configuration * 🔧 add namespaces * 📝 document deprecations * 📝 document documentation generation * 🚸 improve search * 🚸 add examples * 🚧 start adding documentation for macros * 📝 add note for https://github.com/nlohmann/json/issues/874#issuecomment-1001699139 * 📝 overwork example handling * 📝 fix Markdown tables
This commit is contained in:
51
doc/mkdocs/docs/api/basic_json/std_swap.md
Normal file
51
doc/mkdocs/docs/api/basic_json/std_swap.md
Normal file
@ -0,0 +1,51 @@
|
||||
# std::swap<basic_json\>
|
||||
|
||||
```cpp
|
||||
namespace std {
|
||||
void swap(nlohmann::basic_json& j1, nlohmann::basic_json& j2);
|
||||
}
|
||||
```
|
||||
|
||||
Exchanges the values of two JSON objects.
|
||||
|
||||
## Parameters
|
||||
|
||||
`j1` (in, out)
|
||||
: value to be replaced by `j2`
|
||||
|
||||
`j2` (in, out)
|
||||
: value to be replaced by `j1`
|
||||
|
||||
## Possible implementation
|
||||
|
||||
```cpp
|
||||
void swap(nlohmann::basic_json& j1, nlohmann::basic_json& j2)
|
||||
{
|
||||
j1.swap(j2);
|
||||
}
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
??? example
|
||||
|
||||
The following code shows how two values are swapped with `std::swap`.
|
||||
|
||||
```cpp
|
||||
--8<-- "examples/std_swap.cpp"
|
||||
```
|
||||
|
||||
Output:
|
||||
|
||||
```json
|
||||
--8<-- "examples/std_swap.output"
|
||||
```
|
||||
|
||||
## See also
|
||||
|
||||
- [swap](swap.md)
|
||||
|
||||
## Version history
|
||||
|
||||
- Added in version 1.0.0.
|
||||
- Extended for arbitrary basic_json types in version 3.10.5.
|
Reference in New Issue
Block a user