Skip to content

Releases: lawmurray/doxide

v0.8.0

27 Nov 10:03
Compare
Choose a tag to compare
  • 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, run doxide init again, answer no when prompted to overwrite files, but yes for this particular file.

v0.7.1

19 Nov 06:13
Compare
Choose a tag to compare
  • 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 in if constexpr, requires clauses and types.

v0.7.0

13 Nov 11:04
Compare
Choose a tag to compare
  • Adds an experimental doxide cover command that outputs gcov-compatible JSON to enumerate executable lines in the source code. The intended use is to mix this line data with execution data from gcov 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

11 Nov 07:03
Compare
Choose a tag to compare
  • Improved cleaning of the output directory when rebuilding documentation. This greatly improves workflow, making it possible to keep mkdocs serve running when using doxide 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. have generator: 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).

v0.5.0

28 Oct 02:48
Compare
Choose a tag to compare
  • Added support for CUDA C++ language extensions.
  • Improved warning messages for parse errors, reporting only remaining errors after automatic corrections.
  • Updated tree-sitter dependencies to latest versions.

v0.4.6

21 Jun 14:36
Compare
Choose a tag to compare

Fixes handling of indenting in comments for whitespace sensitive Markdown, e.g. nested lists, code blocks (#45).

v0.4.5

06 Apr 14:09
Compare
Choose a tag to compare
  • Numerous fixes for Markdown formatting in conjunction with /// style documentation comments (#41)

v0.4.4

13 Feb 00:34
Compare
Choose a tag to compare
  • Fixed parse error on standalone @ characters (without commands) #7.

v0.4.3

04 Feb 18:26
Compare
Choose a tag to compare
  • Fix for multiline /// style documentation comments (#38).

v0.4.2

20 Jan 19:13
Compare
Choose a tag to compare
  • Fixed member variables of pointer and reference type #34.
  • Updated Material for MkDocs dependencies #37.
  • Fixed incorrect overwrite of files without generator: doxide in YAML frontmatter. Warning now produced, and file is not overwritten.