mirror of
https://github.com/nlohmann/json.git
synced 2026-10-02 20:50:32 +00:00
Niels Lohmann
63c10a51fc
* Review and extend the documentation, and check it in CI A review of all documentation pages found factual errors, dead links, missing cross-references, and gaps in examples. This fixes them and adds checks so the same problems are caught automatically. Fixes: - wrong signatures and version histories (operator!= C++20 member, binary() subtype type, get<PointerType>(), JSON_NO_THREAD_LOCAL, ...) - stale descriptions (number parsing since #5283, UBJSON table, SAX example that no longer compiled, tsl::ordered_map advice) - dead internal and external links; repology.org badges (the domain is suspended) replaced by badges that query the registries directly - deprecation notes link the migration guide; the guide itself fixed Additions: - "See also" sections, cross-references, 25 runnable examples, 12 Mermaid diagrams, new API pages for json_pointer::operator<=> and byte_container_with_subtype::operator==/!= - landing page, guides for untrusted input and performance - "unreleased" badge after versions newer than the latest release Checks: - strict documentation build (broken links/anchors fail it); CI and the publish workflow fetch the full history the build needs - weekly external link check, Mermaid syntax check in CI - check_structure.py: example titles, heading levels, alt texts, header links, docset index coverage; its unused-example check works again - all examples produce the same output on every platform Signed-off-by: Niels Lohmann <mail@nlohmann.me> * Keep the customer links that could not be fixed A dead link on the customers page is still the evidence of where the use of the library was documented. Keep the original URLs of the entries without a working replacement (Marne, Cisco Webex Desk Camera, Philips Hue, CyberArk) and exclude exactly these URLs from the link check. Signed-off-by: Niels Lohmann <mail@nlohmann.me> * Correct the duplicate-key recipe's claim about SAX positions The SAX interface's key() receives no position either; only parse_error() does. Also note that the recipe does not report the path to the repeated key (see discussion #5085). Signed-off-by: Niels Lohmann <mail@nlohmann.me> * Say the library is available as a single header and mention json_fwd.hpp Signed-off-by: Niels Lohmann <mail@nlohmann.me> * Correct documentation errors found while hunting for bugs - patch/patch_inplace: list the JSON pointer errors parse_error.106-109 and out_of_range.402/404, and quote the actual parse_error.105 message. - unflatten: list parse_error.106/107/108 and out_of_range.404. - to_bson: list out_of_range.415 (binary subtype above 255) and note that 412 and 415 are new in 3.13.0. - to_string: state that string_t must be convertible to std::string, also in the StringType requirements table. - JSON Lines: a `while (input >> j)` loop also throws after the last value for concatenated JSON values; show a loop that works for both. - BON8: a string gets 0xFF only if nothing follows it in the message; a string at the end of an array or object is ended by 0xFE. - custom_string_type.hpp: add operator+=(char), which the "Always required" list asks for (json_pointer::to_string, flatten, unflatten, and diff did not compile), and an ADL int_to_string for diff and items. Signed-off-by: Niels Lohmann <mail@nlohmann.me> * Cache the release headers with functools.lru_cache Codacy (Pylint) flagged the mutable default argument that header() used as its cache. functools.lru_cache keeps the same memoization without it. The script's output is unchanged. Signed-off-by: Niels Lohmann <mail@nlohmann.me> --------- Signed-off-by: Niels Lohmann <mail@nlohmann.me>
57 lines
2.0 KiB
Makefile
57 lines
2.0 KiB
Makefile
SRCDIR = ../single_include
|
|
|
|
all: create_output
|
|
|
|
##########################################################################
|
|
# example files
|
|
##########################################################################
|
|
|
|
# where are the example cpp files
|
|
EXAMPLES = $(wildcard mkdocs/docs/examples/*.cpp)
|
|
|
|
cxx_standard = $(lastword c++11 $(filter c++%, $(subst ., ,$1)))
|
|
|
|
# common compile flags for the stand-alone example files
|
|
EXAMPLE_CPPFLAGS = -I $(SRCDIR) -DJSON_USE_GLOBAL_UDLS=0
|
|
EXAMPLE_WARNFLAGS = -Werror=deprecated-declarations
|
|
|
|
# examples that document deprecated API and are allowed to use it
|
|
DEPRECATED_EXAMPLES = $(addprefix mkdocs/docs/examples/, \
|
|
json_pointer__operator__equal_stringtype \
|
|
json_pointer__operator__notequal_stringtype \
|
|
json_pointer__operator_string_t)
|
|
$(DEPRECATED_EXAMPLES:=.output) $(DEPRECATED_EXAMPLES:=.test): EXAMPLE_WARNFLAGS = -Wno-deprecated-declarations
|
|
|
|
# create output from a stand-alone example file
|
|
%.output: %.cpp
|
|
@echo "standard $(call cxx_standard,$(<:.cpp=))"
|
|
$(MAKE) $(<:.cpp=) \
|
|
CPPFLAGS="$(EXAMPLE_CPPFLAGS)" \
|
|
CXXFLAGS="-std=$(call cxx_standard,$(<:.cpp=)) $(EXAMPLE_WARNFLAGS)"
|
|
./$(<:.cpp=) > $@
|
|
rm $(<:.cpp=)
|
|
|
|
# compare created output with current output of the example files
|
|
%.test: %.cpp
|
|
$(MAKE) $(<:.cpp=) \
|
|
CPPFLAGS="$(EXAMPLE_CPPFLAGS)" \
|
|
CXXFLAGS="-std=$(call cxx_standard,$(<:.cpp=)) $(EXAMPLE_WARNFLAGS)"
|
|
./$(<:.cpp=) > $@
|
|
diff $@ $(<:.cpp=.output)
|
|
rm $(<:.cpp=) $@
|
|
|
|
# create output from all stand-alone example files
|
|
create_output: $(EXAMPLES:.cpp=.output)
|
|
|
|
# check output of all stand-alone example files
|
|
check_output: $(EXAMPLES:.cpp=.test)
|
|
|
|
# check output of all stand-alone example files (exclude files whose output depends on the platform by nature:
|
|
# library and compiler information, container size limits, and hash values)
|
|
# This target is used in the CI (ci_test_documentation).
|
|
check_output_portable: $(filter-out mkdocs/docs/examples/meta.test mkdocs/docs/examples/max_size.test mkdocs/docs/examples/std_hash.test,$(EXAMPLES:.cpp=.test))
|
|
|
|
clean:
|
|
rm -fr $(EXAMPLES:.cpp=)
|
|
$(MAKE) clean -C docset
|