DVT VHDL IDE User Guide
Rev. 22.1.36, 22 November 2022

32.1.1 Javadoc

Comments written in Javadoc will be formatted based on the following tags:

Tag Name Comment Tooltip Window Notes
Author
 
Link
{ @link object_name label}


As links you can have an object name. If you Ctrl + right click on a link, it will jump to its declaration.
Param
 
Return
 
See
@see object_name label


@see <a href=URL>label</a>


As links you can have: an object name, a file, a valid web URL. If you Ctrl + right click on a link that contains an object name, it will jump to its declaration. Everything you link with @see tag will be placed in a separate section at the bottom of the comment, named "See also".
Since
 
Version
 

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