mirror of
https://github.com/nlohmann/json.git
synced 2026-09-30 22:15:19 +00:00
cc36e26254
Add API reference pages for basic_json_document::insert and basic_json_document::erase, matching the style of set.md and push_back.md: signatures, parameters, return values, exception safety, exceptions with their exact ids and messages, complexity, notes on duplicate keys and view/iterator validity, and an example. Add example programs basic_json_document__insert.cpp and basic_json_document__erase.cpp with their expected output, each comparing an edit on an editable document with the same edit on a plain json value to show what is preserved: member order, the spelling of untouched numbers, and, for insert, that a view taken before the insert keeps referring to the same element after its index shifts. Register both new pages in mkdocs.yml, docSet.sql, and the member list of basic_json_document/index.md, add cross-references to them from set.md and push_back.md, and mention insert/erase in the "Editing a document" section of features/json_view.md. Signed-off-by: Niels Lohmann <mail@nlohmann.me>
docset
The folder contains the required files to create a docset which can be used in documentation browsers like Dash, Velocity, or Zeal.
The docset can be created with
make nlohmann_json.docset
The generated folder nlohmann_json.docset can then be opened in the documentation browser.
A recent version is also part of the Dash user contributions.
Licenses
The JSON logo is public domain.
