Specador Documentation Generator User Guide
Rev. 23.1.22, 22 September 2023
| Specador offers the ability to export custom generated diagrams directly from comment descriptions. Below is an example on how to embed PlantUML diagrams in the Specador documentation:
![]()
![]()
When writing custom diagram descriptions, they need to be enclosed between DVT_DIAGRAM_START and DVT_DIAGRAM_END pragmas. Available options when writing custom diagram descriptions: @program [MANDATORY] Absolute path to the external diagram generator or the name of the diagram generator to be searched in $PATH (environment variables are supported) Important: Specador will invoke the generator as follows: @program @input_file @output_file @args Note: SystemVerilog module parameters and macros default values can also be passed to the input description using the following syntax:
![]()
|