🚧 start adding documentation for macros
This commit is contained in:
parent
bb0d6d1a9c
commit
0a5b16f165
18
doc/mkdocs/docs/api/macros/index.md
Normal file
18
doc/mkdocs/docs/api/macros/index.md
Normal file
@ -0,0 +1,18 @@
|
||||
# Macros
|
||||
|
||||
Some aspects of the library can be configured by defining preprocessor macros before including the `json.hpp` header.
|
||||
|
||||
- [`JSON_ASSERT(x)`](json_assert.md)
|
||||
- `JSON_CATCH_USER(exception)`
|
||||
- `JSON_DIAGNOSTICS`
|
||||
- `JSON_HAS_CPP_11`, `JSON_HAS_CPP_14`, `JSON_HAS_CPP_17`, `JSON_HAS_CPP_20`
|
||||
- `JSON_NOEXCEPTION`
|
||||
- `JSON_NO_IO`
|
||||
- `JSON_SKIP_UNSUPPORTED_COMPILER_CHECK`
|
||||
- `JSON_THROW_USER(exception)`
|
||||
- `JSON_TRY_USER`
|
||||
- `JSON_USE_IMPLICIT_CONVERSIONS`
|
||||
- `NLOHMANN_DEFINE_TYPE_INTRUSIVE(type, member...)`
|
||||
- `NLOHMANN_DEFINE_TYPE_NON_INTRUSIVE(type, member...)`
|
||||
- `NLOHMANN_JSON_SERIALIZE_ENUM(type, ...)`
|
||||
- `NLOHMANN_JSON_VERSION_MAJOR`, `NLOHMANN_JSON_VERSION_MINOR`, `NLOHMANN_JSON_VERSION_PATCH`
|
||||
11
doc/mkdocs/docs/api/macros/json_assert.md
Normal file
11
doc/mkdocs/docs/api/macros/json_assert.md
Normal file
@ -0,0 +1,11 @@
|
||||
# JSON_ASSERT(x)
|
||||
|
||||
```cpp
|
||||
JSON_ASSERT(x)
|
||||
```
|
||||
|
||||
## Default implementation
|
||||
|
||||
```cpp
|
||||
assert(x);
|
||||
```
|
||||
@ -228,6 +228,9 @@ nav:
|
||||
- 'string': api/json_sax/string.md
|
||||
- 'ordered_json': api/ordered_json.md
|
||||
- 'ordered_map': api/ordered_map.md
|
||||
- macros:
|
||||
- 'Overview': api/macros/index.md
|
||||
- 'JSON_ASSERT(x)': api/macros/json_assert.md
|
||||
|
||||
# Extras
|
||||
extra:
|
||||
|
||||
Loading…
Reference in New Issue
Block a user