diff --git a/doc/mkdocs/docs/api/macros/index.md b/doc/mkdocs/docs/api/macros/index.md new file mode 100644 index 000000000..9c390d55e --- /dev/null +++ b/doc/mkdocs/docs/api/macros/index.md @@ -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` diff --git a/doc/mkdocs/docs/api/macros/json_assert.md b/doc/mkdocs/docs/api/macros/json_assert.md new file mode 100644 index 000000000..63d4ae076 --- /dev/null +++ b/doc/mkdocs/docs/api/macros/json_assert.md @@ -0,0 +1,11 @@ +# JSON_ASSERT(x) + +```cpp +JSON_ASSERT(x) +``` + +## Default implementation + +```cpp +assert(x); +``` diff --git a/doc/mkdocs/mkdocs.yml b/doc/mkdocs/mkdocs.yml index d716c2d9a..220897e4b 100644 --- a/doc/mkdocs/mkdocs.yml +++ b/doc/mkdocs/mkdocs.yml @@ -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: