open-source-parsers / jsoncpp / 32591488963

90%

push

github

docs: modernize doxygen build and publish from this repository (#1711)

* docs: modernize doxygen build and publish from this repository

The API docs were last published to the separate jsoncpp-docs repo in
January 2021 (for 1.9.4) and the local doxygen build has been broken
since the versioning rework removed the top-level `version` file.

Build fixes:
- doxybuild.py reads the version from include/json/version.h instead of
  a `version` file that CMake only generates in the build directory.
- doc/doxyfile.in is reduced to the non-default settings (the 2013-era
  1.8.5 template triggered 17 obsolete-tag warnings on current doxygen)
  and now sets WARN_AS_ERROR so documentation regressions fail the build.
- JSONCPP_DEPRECATED/JSON_API are stripped during preprocessing and
  __cplusplus=201703L is predefined, so deprecated members and the
  std::string_view overloads are documented.

Documentation fixes:
- reader.h / writer.h: a mismatched 'settings_` quote opened a backtick
  span that swallowed the rest of each header, leaving CharReaderBuilder
  and StreamWriterBuilder effectively undocumented.
- value.h: document the remaining parameters of Value::get and
  Value::removeMember.
- json_value.cpp: hide the private Value::CZString implementation from
  doxygen with \cond.

Output:
- Style with doxygen-awesome-css v2.4.2 (vendored, MIT) in place of the
  1.8.13-era header/footer templates; enable tree view and search.
- Use README.md as the main page; jsoncpp.dox becomes a "Quick start"
  page with the dead SourceForge links removed. Drop the 3-line roadmap
  stub and the redundant web_doxyfile.in.

Publishing:
- New docs workflow builds on pull requests (as a warning check) and
  deploys to GitHub Pages on pushes to master with a pinned,
  checksum-verified doxygen 1.18.0. README links now point at
  https://open-source-parsers.github.io/jsoncpp/.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

* docs: pin workflow actions, drop fragile calle... (continued)

2222 of 2640 branches covered (84.17%)

Branch coverage included in aggregate %.

2615 of 2740 relevant lines covered (95.44%)

23828.01 hits per line