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:
@ -1,4 +1,4 @@
|
||||
# basic_json::get
|
||||
# <small>nlohmann::basic_json::</small>get
|
||||
|
||||
```cpp
|
||||
// (1)
|
||||
@ -31,7 +31,7 @@ constexpr const PointerType get_ptr() const noexcept;
|
||||
return ret;
|
||||
```
|
||||
|
||||
This overloads is chosen if:
|
||||
This overload is chosen if:
|
||||
|
||||
- `ValueType` is not `basic_json`,
|
||||
- `json_serializer<ValueType>` has a `from_json()` method of the form
|
||||
@ -48,7 +48,7 @@ constexpr const PointerType get_ptr() const noexcept;
|
||||
return JSONSerializer<ValueTypeCV>::from_json(*this);
|
||||
```
|
||||
|
||||
This overloads is chosen if:
|
||||
This overload is chosen if:
|
||||
|
||||
- `ValueType` is not `basic_json` and
|
||||
- `json_serializer<ValueType>` has a `from_json()` method of the form
|
||||
@ -94,7 +94,7 @@ Depends on what `json_serializer<ValueType>` `from_json()` method throws
|
||||
|
||||
Writing data to the pointee (overload 3) of the result yields an undefined state.
|
||||
|
||||
## Example
|
||||
## Examples
|
||||
|
||||
??? example
|
||||
|
||||
|
Reference in New Issue
Block a user