mirror of
https://github.com/nlohmann/json.git
synced 2025-07-31 10:24:23 +03:00
Some documentation updates (#4636)
Signed-off-by: Niels Lohmann <mail@nlohmann.me>
This commit is contained in:
@ -42,6 +42,10 @@ operator string_t() const
|
||||
--8<-- "examples/json_pointer__operator_string_t.output"
|
||||
```
|
||||
|
||||
## See also
|
||||
|
||||
- [string_t](../basic_json/string_t.md)- type for strings
|
||||
|
||||
## Version history
|
||||
|
||||
- Since version 2.0.0.
|
||||
|
@ -79,6 +79,10 @@ Therefore, assertions can be switched off by defining `NDEBUG`.
|
||||
assertion error in operator[]
|
||||
```
|
||||
|
||||
## See also
|
||||
|
||||
- [Runtime Assertions](../../features/assertions.md) - overview documentation
|
||||
|
||||
## Version history
|
||||
|
||||
- Added in version 3.9.0.
|
||||
|
@ -108,6 +108,12 @@ When the macro is not defined, the library will define it to its default value.
|
||||
```
|
||||
|
||||
The output shows the exception with diagnostic path info and start/end positions.
|
||||
|
||||
## See also
|
||||
|
||||
- [:simple-cmake: JSON_Diagnostic_Positions](../../integration/cmake.md#json_diagnostic_positions) - CMake option to control the macro
|
||||
- [JSON_DIAGNOSTICS](json_diagnostics.md) - macro to control extended diagnostics
|
||||
|
||||
## Version history
|
||||
|
||||
- Added in version 3.12.0.
|
||||
|
@ -82,7 +82,12 @@ When the macro is not defined, the library will define it to its default value.
|
||||
--8<-- "examples/diagnostic_positions_exception.output"
|
||||
```
|
||||
The output shows the exception with start/end positions only.
|
||||
|
||||
|
||||
## See also
|
||||
|
||||
- [:simple-cmake: JSON_Diagnostics](../../integration/cmake.md#json_diagnostics) - CMake option to control the macro
|
||||
- [JSON_DIAGNOSTIC_POSITIONS](json_diagnostic_positions.md) - macro to access positions of elements
|
||||
|
||||
## Version history
|
||||
|
||||
- Added in version 3.10.0.
|
||||
|
@ -145,7 +145,9 @@ The default value is `0`.
|
||||
|
||||
## See also
|
||||
|
||||
- [`NLOHMANN_JSON_SERIALIZE_ENUM`](nlohmann_json_serialize_enum.md)
|
||||
- [:simple-cmake: JSON_DisableEnumSerialization](../../integration/cmake.md#json_disableenumserialization) - CMake option to control
|
||||
the macro
|
||||
- [`NLOHMANN_JSON_SERIALIZE_ENUM`](nlohmann_json_serialize_enum.md) - serialize/deserialize an enum
|
||||
|
||||
## Version history
|
||||
|
||||
|
@ -92,6 +92,7 @@ When the macro is not defined, the library will define it to its default value.
|
||||
|
||||
- [`operator""_json`](../operator_literal_json.md)
|
||||
- [`operator""_json_pointer`](../operator_literal_json_pointer.md)
|
||||
- [:simple-cmake: JSON_GlobalUDLs](../../integration/cmake.md#json_globaludls) - CMake option to control the macro
|
||||
|
||||
## Version history
|
||||
|
||||
|
@ -53,6 +53,7 @@ By default, implicit conversions are enabled.
|
||||
|
||||
- [**operator ValueType**](../basic_json/operator_ValueType.md) - get a value (implicit)
|
||||
- [**get**](../basic_json/get.md) - get a value (explicit)
|
||||
- [:simple-cmake: JSON_ImplicitConversions](../../integration/cmake.md#json_implicitconversions) - CMake option to control the macro
|
||||
|
||||
## Version history
|
||||
|
||||
|
@ -72,6 +72,10 @@ When the macro is not defined, the library will define it to its default value.
|
||||
...
|
||||
```
|
||||
|
||||
### See also
|
||||
|
||||
- [:simple-cmake: JSON_LegacyDiscardedValueComparison](../../integration/cmake.md#json_legacydiscardedvaluecomparison) - CMake option to control the macro
|
||||
|
||||
## Version history
|
||||
|
||||
- Added in version 3.11.0.
|
||||
|
@ -138,3 +138,7 @@ result in undefined behavior. Since version 3.11.4, this library checks for `nul
|
||||
```
|
||||
[json.exception.parse_error.101] parse error: attempting to parse an empty input; check that your input string or stream contains the expected JSON
|
||||
```
|
||||
|
||||
## See also
|
||||
|
||||
- [JSON_ASSERT](../api/macros/json_assert.md) - control behavior of runtime assertions
|
||||
|
@ -24,11 +24,26 @@ When enabled, exception messages contain a [JSON Pointer](json_pointer.md) to th
|
||||
exception, see [Extended diagnostic messages](../home/exceptions.md#extended-diagnostic-messages) for an example. Note
|
||||
that enabling this macro increases the size of every JSON value by one pointer and adds some runtime overhead.
|
||||
|
||||
The diagnostics messages can also be controlled with the CMake option `JSON_Diagnostics` (`OFF` by default) which sets
|
||||
`JSON_DIAGNOSTICS` accordingly.
|
||||
The diagnostics messages can also be controlled with the CMake option
|
||||
[`JSON_Diagnostics`](../integration/cmake.md#json_diagnostics) (`OFF` by default) which sets `JSON_DIAGNOSTICS`
|
||||
accordingly.
|
||||
|
||||
See [full documentation of `JSON_DIAGNOSTICS`](../api/macros/json_diagnostics.md).
|
||||
|
||||
## `JSON_DIAGNOSTIC_POSITIONS`
|
||||
|
||||
When enabled, two new member functions [`start_pos()`](../api/basic_json/start_pos.md) and
|
||||
[`end_pos()`](../api/basic_json/end_pos.md) are added to [`basic_json`](../api/basic_json/index.md) values. If the value
|
||||
was created by calling the[`parse`](../api/basic_json/parse.md) function, then these functions allow to query the byte
|
||||
positions of the value in the input it was parsed from. The byte positions are also used in exceptions to help locate
|
||||
errors.
|
||||
|
||||
The diagnostics positions can also be controlled with the CMake option
|
||||
[`JSON_Diagnostic_Positions`](../integration/cmake.md#json_diagnostic_positions) (`OFF` by default) which sets
|
||||
`JSON_DIAGNOSTIC_POSITIONS` accordingly.
|
||||
|
||||
See [full documentation of `JSON_DIAGNOSTIC_POSITIONS`](../api/macros/json_diagnostic_positions.md)
|
||||
|
||||
## `JSON_HAS_CPP_11`, `JSON_HAS_CPP_14`, `JSON_HAS_CPP_17`, `JSON_HAS_CPP_20`
|
||||
|
||||
The library targets C++11, but also supports some features introduced in later C++ versions (e.g., `std::string_view`
|
||||
|
Reference in New Issue
Block a user