DVT SystemVerilog IDE User Guide
Rev. 24.2.25, 31 October 2024

41.1.2 Natural Docs

Comments written in Natural Docs will be formatted based on the following syntax:

Tag Name Comment Tooltip Window Notes
Bold Font
 
Bullet List
 
Definition List
 
Heading
If the markup language preference is set to "Autodetect", you must include another Natural Docs specific syntax in order to activate the Natural Docs formatter on this pattern.
Image
The path can be either absolute, relative to the current file or relative to additional image locations. To specify additional image locations use +dvt_natural_docs_image_locations directive.
Italic Font
 
Line Syntax
If the markup language preference is set to "Autodetect", you must include another Natural Docs specific syntax in order to activate the Natural Docs formatter on this pattern.
Link
<label: URL>


<label at URL>


As links you can have: an object name, a file or a valid web URL. If you Ctrl + right click on a link that contains an object name, it will jump to its declaration.
Start Code
 
Topic Line
 
Underline Font
 

It's similar to Specador documentation for Natural Docs that you can check out right here.