amorfo77/json
1
0
Fork 0
mirror of https://github.com/nlohmann/json.git synced 2026-10-04 13:40:33 +00:00
Code Issues Packages Projects Releases Wiki Activity

📝 update documentation (#4723)

Browse Source 
Signed-off-by: Niels Lohmann <mail@nlohmann.me>
This commit is contained in:
Niels Lohmann
2025-04-05 18:54:35 +02:00
committed by GitHub
parent 11aa5f944d
commit 4424a0fcc1
90 changed files with 377 additions and 339 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/mkdocs/docs/integration/cmake.md
+4 -4
View File
@@ -90,7 +90,7 @@ to the following.
### FetchContent
Since CMake v3.11, [FetchContent](https://cmake.org/cmake/help/v3.11/module/FetchContent.html) can be used to
automatically download a release as a dependency at configure type.
automatically download a release as a dependency at configure time.
!!! example
@@ -167,12 +167,12 @@ Enable the (incorrect) legacy comparison behavior of discarded JSON values by de
### `JSON_MultipleHeaders`
Use non-amalgamated version of the library. This option is `OFF` by default.
Use the non-amalgamated version of the library. This option is `OFF` by default.
### `JSON_SystemInclude`
Treat the library headers like system headers (i.e., adding `SYSTEM` to the [`target_include_directories`](https://cmake.org/cmake/help/latest/command/target_include_directories.html) call) to checks for this library by tools like Clang-Tidy. This option is `OFF` by default.
Treat the library headers like system headers (i.e., adding `SYSTEM` to the [`target_include_directories`](https://cmake.org/cmake/help/latest/command/target_include_directories.html) call) to check for this library by tools like Clang-Tidy. This option is `OFF` by default.
### `JSON_Valgrind`
Execute test suite with [Valgrind](https://valgrind.org). This option is `OFF` by default. Depends on `JSON_BuildTests`.
Execute the test suite with [Valgrind](https://valgrind.org). This option is `OFF` by default. Depends on `JSON_BuildTests`.
docs/mkdocs/docs/integration/migration_guide.md
+2 -2
View File
@@ -260,5 +260,5 @@ exact version and configuration is relevant, use macro
## Do not use the `details` namespace
The `details` namespace is not part of the public API of the library and can change in any version without announcement.
Do not rely on any function or type in the `details` namespace.
The `details` namespace is not part of the public API of the library and can change in any version without an
announcement. Do not rely on any function or type in the `details` namespace.
docs/mkdocs/docs/integration/package_managers.md
+2 -2
View File
@@ -163,7 +163,7 @@ using the subproject directly.
- :octicons-question-24: [Bazel website](https://bazel.build)
This repository provides a [Bazel](https://bazel.build/) `MODULE.bazel` and a corresponding `BUILD.bazel` file. Therefore, this
repository can be referenced within a `MODULE.bazel` by rules such as `archive_override`, `git_override`, or `local_path_override`. To use the library you need to depend on the target `@nlohmann_json//:json` (i.e., via `deps` attribute).
repository can be referenced within a `MODULE.bazel` by rules such as `archive_override`, `git_override`, or `local_path_override`. To use the library, you need to depend on the target `@nlohmann_json//:json` (i.e., via `deps` attribute).
??? example
@@ -307,7 +307,7 @@ the [nlohmann_json package](https://hunter.readthedocs.io/en/latest/packages/pkg
hunter_add_package(nlohmann_json)
```
Please see the Hunter project for any issues regarding the packaging.
Please see the Hunter project for any issues regarding the packaging.
??? example