json/docs/mkdocs at 19611448740c5dcb635ca3915193ae1cf7a45b99 - json

mirror of https://github.com/nlohmann/json.git synced 2026-09-02 14:37:17 +00:00

Files

T

Niels Lohmann b38c4cc937 docs: add compiled reference implementations for the container template parameters

Each of ObjectType, ArrayType, StringType, and BinaryType now links to a
minimal, self-contained header (docs/mkdocs/docs/examples/custom_*_type.hpp)
that wraps the corresponding standard container by composition and satisfies
every "Always required" member listed on that page. Unlike the prose
requirement lists, these are real code: each header has a companion .cpp that
instantiates a basic_json specialization with it and is compiled and run by
the existing ci_test_examples check (docs/Makefile's check_output_portable),
so the reference implementations cannot silently drift from what the library
actually requires. The .output files were generated with that same target.

StringType's existing pointer to tests/src/unit-alt-string.cpp's alt_string
is kept alongside the new header as a more thorough, battle-tested example.

Verified locally: astyle (pinned 3.4.13, project .astylerc) on the new files;
clang++/g++ under C++11/17/20 for each example against the amalgamated
header; `make check_output_portable` in docs/; `mkdocs build --strict` and
scripts/check_structure.py for the page itself.

Signed-off-by: Niels Lohmann <mail@nlohmann.me>

2026-09-02 09:31:19 +02:00

docs

docs: add compiled reference implementations for the container template parameters

2026-09-02 09:31:19 +02:00

hooks

📝 make documentation more LLM friendly (#5244 )

2026-07-08 20:18:24 +02:00

includes

Clean up and document project files (#4560 )

2025-01-17 06:53:35 +01:00

scripts

Clean up and document project files (#4560 )