Releases: lawmurray/doxide
Releases · lawmurray/doxide
v0.8.0
- Major new feature! Code coverage reports, integrating data from compiled binaries provided by
gcov
with source code analysis from tree-sitter for more accurate C++ code coverage reports, also accounting for uninstantiated function templates, which are typically omitted by other code coverage tools. Code coverage reports feature an interactive sunburst chart using Apache ECharts, and sortable tables using tablesort. See the demonstration for an example and the documentation to get set up. - Fixed
mathjax.js
content, which was populating for a different file. If affected by this, rundoxide init
again, answer no when prompted to overwrite files, but yes for this particular file.
v0.7.1
- Template specializations now included, if documented.
- Improved error handling for parse errors in YAML frontmatter; will now continue rather than exit.
- Sanitized output of
operator[](...)
, which looks like a link in Markdown. - Removed unnecessary use of polyfill JavaScript from default output of
doxide init
. - Improved line inclusions and exclusions for new code coverage support (
doxide cover
), e.g. including lines that contain expressions that may be executed, but excluding compile-time executed expressions such as inif constexpr
,requires
clauses and types.
v0.7.0
- Adds an experimental
doxide cover
command that outputsgcov
-compatible JSON to enumerate executable lines in the source code. The intended use is to mix this line data with execution data fromgcov
for more accurate C++ code coverage reports, addressing the problem of uninstantiated function templates being ignored by code coverage tools. - Minor improvement to extraction of brief descriptions (#52).
- Minor fix for presentation of macros (#53).
v0.6.0
- Improved cleaning of the output directory when rebuilding documentation. This greatly improves workflow, making it possible to keep
mkdocs serve
running when usingdoxide build
without the browser automatically refreshing to 404 errors due to an intermediate state. Rather than deleting all generated files and then recreating them, files are now overwritten and new files generated where necessary, before a second pass removes old files that are no longer required (but that were previously generated, i.e. havegenerator: doxide
in their YAML frontmatter). - Workaround for
mkdocs
removing underscores and capitalizing titles in its navigation menu. Entity names are now preserved. - Parameter and Template Parameter headings are no longer shown. Longer term, looking for ways to reduce whitespace and make the documentation more compact.
- Fixed handling of array variables (#50).