Skip to content

Releases

HDL-AutoDoc-Lite v3.21.0

Choose a tag to compare

@github-actions github-actions released this 09 Nov 10:23

Full Changelog: v3.20.0...v3.21.0

HDL-AutoDoc-Lite v3.20.0

Choose a tag to compare

@github-actions github-actions released this 09 Nov 10:02

Full Changelog: v3.19.0...v3.20.0

HDL-AutoDoc-Lite v3.19.0

Choose a tag to compare

@github-actions github-actions released this 09 Nov 09:29

Full Changelog: v3.18.4...v3.19.0

HDL-AutoDoc-Lite v3.18.4

Choose a tag to compare

@github-actions github-actions released this 08 Nov 20:40

Full Changelog: v3.18.3...v3.18.4

HDL-AutoDoc-Lite v3.18.3

Choose a tag to compare

@github-actions github-actions released this 08 Nov 14:40

Full Changelog: v3.18.2...v3.18.3

HDL-AutoDoc-Lite v3.18.2

Choose a tag to compare

@github-actions github-actions released this 08 Nov 14:31

Full Changelog: v3.18.1...v3.18.2

HDL-AutoDoc-Lite v3.18.1

Choose a tag to compare

@github-actions github-actions released this 08 Nov 14:28

Full Changelog: v3.18.0...v3.18.1

v3.18.0

Choose a tag to compare

@FPGA-James FPGA-James released this 06 Nov 10:42

New features

  • Documentation statistics — make doc-coverage now 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 to docs/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_GENERICS and COVERAGE_MIN_HEADERS (percent) make make doc-coverage fail when the documented share is lower. COVERAGE_STATS=0 keeps only the original table and writes no JSON.
  • VS Code extension: finds Python itself — with hdlAutodoc.pythonPath empty it tries python3, 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) and a, b : in std_logic; c : out std_logic (VHDL) now give one port each in the block diagram, the port tables and autodoc_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.json are additional (COVERAGE_STATS=0 removes them).