mirror of https://github.com/nlohmann/json.git synced 2026-08-05 16:53:19 +00:00

Files

T

Niels LohmannandGitHub 1c63a120b6 docs: document how discarded values are removed by the parser callback (#5354 )

Follow-up to #5342, which fixed the parser callback leaving a discarded
member behind when an array or a value under an object key was rejected.
The documentation of parser_callback_t only stated that discarded values
in structured types are skipped, without saying that this covers object
parents and that the key is removed along with the value, so there was no
way to tell the fixed behavior from the buggy one.

Spell out the discarding rules, add an example that exercises the cases
the fix repaired, and correct the return value description: a discarded
top-level value is replaced by null, not by "an empty discarded object".

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

2026-08-04 08:45:02 +02:00

docset

Documentation review: fix stale version-history placeholder in operator_ne.md (#5261 )

2026-07-09 20:57:41 +02:00

mkdocs

docs: document how discarded values are removed by the parser callback (#5354 )

2026-08-04 08:45:02 +02:00

avatars.png

🔖 set version to 3.12.0 (#4727 )

2025-04-11 10:41:14 +02:00

json.gif

🔖 set version to 3.12.0 (#4727 )

2025-04-11 10:41:14 +02:00

Makefile

Clean up and document project files (#4560 )

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

README.md

docs: improve clarity and formatting in documentation generation section (#5021 )

2025-12-03 00:15:27 +01:00

README.md

Documentation

Generate documentation

Note on documentation: The source files contain links to the online documentation at https://json.nlohmann.me.
This URL provides the most recent documentation and also applies to previous versions. Documentation for deprecated functions is not removed; instead, it is marked as deprecated.

If you want to view the documentation for a specific tag or commit hash, you can generate it locally as follows (example using tag v3.10.2):

git clone https://github.com/nlohmann/json.git
cd json
git checkout v3.10.2
make install_venv serve -C docs/mkdocs

Open http://127.0.0.1:8000/ in your browser. Replace any URL in the source code that points to https://json.nlohmann.me with http://127.0.0.1:8000 to view the documentation for the selected tag or commit hash.