DVT VHDL IDE User Guide
Rev. 23.2.28, 28 November 2023
To generate the HTML Documentation click on Specador -> Export HTML Documentation... menu entry (requires a Specador license). This action will bring-up a dialog for specifying preferences:
1. General Page
2. API Selection Preferences
Check what kind of API and what packages to include in documentation.
3. Filter Preferences
4. Styling Preferences
Comments beautify and formatting.
5. Link To Existing Documentation
Create links to the elements for which documentation is already generated in the directories specified in the list above, instead of re-generating their HTML pages. You can also select if you want to see references to external documentation's index.html files in the left navigation menu.
The HTML documentation is similar with JavaDoc and it is generated using the comments above type declarations, method declarations etc.
6. Diagrams Page
Check which kind of diagrams you want to include in the HTML documentation.
7. FSM Diagrams Preferences Page
Change the look and feel of FSM Diagrams.
NOTE: It is recommended to perform a full build before exporting the HTML documentation.
NOTE: For more informations check out the Specador User Guide.