Repository navigation
Releases
Releases · RTL-Tools/HDL-AutoDoc
HDL-AutoDoc-Lite v3.21.0
Full Changelog: v3.20.0...v3.21.0
HDL-AutoDoc-Lite v3.20.0
Full Changelog: v3.19.0...v3.20.0
HDL-AutoDoc-Lite v3.19.0
Full Changelog: v3.18.4...v3.19.0
HDL-AutoDoc-Lite v3.18.4
Full Changelog: v3.18.3...v3.18.4
HDL-AutoDoc-Lite v3.18.3
Full Changelog: v3.18.2...v3.18.3
HDL-AutoDoc-Lite v3.18.2
Full Changelog: v3.18.1...v3.18.2
HDL-AutoDoc-Lite v3.18.1
Full Changelog: v3.18.0...v3.18.1
v3.18.0
New features
- Documentation statistics —
make doc-coveragenow adds, below the existing table, per-module and project figures: ports and generics (parameters) described, processes with a WaveDrom or Mermaid diagram, header description present, comment-to-code line ratio, registers, testbenches and tests, and generated pages. They are also written todocs/hdl_autodoc/coverage.json. A port or generic counts as described when its comment is not empty; its length is not judged. - Minimums for CI —
COVERAGE_MIN_PORTS,COVERAGE_MIN_GENERICSandCOVERAGE_MIN_HEADERS(percent) makemake doc-coveragefail when the documented share is lower.COVERAGE_STATS=0keeps only the original table and writes no JSON. - VS Code extension: finds Python itself — with
hdlAutodoc.pythonPathempty it triespython3,python,py -3, versioned names and Homebrew's locations, and uses the first that is 3.11 or newer; the error names the versions it found. The setting accepts~and${workspaceFolder}, and a probe that hangs is stopped after five seconds.
Fixes
- Several ports on one line —
input logic a, b, c(SystemVerilog) anda, b : in std_logic; c : out std_logic(VHDL) now give one port each in the block diagram, the port tables andautodoc_json.py; a trailing comment goes to the last port, a preceding one to the first.
Compatibility
- Backwards compatible: the coverage table's columns and totals are unchanged; the extra section and
coverage.jsonare additional (COVERAGE_STATS=0removes them).