The table below lists the JavaDoc tags that DVT recognizes. For more details see
http://en.wikipedia.org/wiki/Javadoc.
JavaDoc Links
An in-line link in a comment can be created using this tag
{@link LINK_ADDRESS LINK_TEXT}.There are two types of links:
TYPE_NAME.INNER_TYPE_NAME or just
TYPE_NAME for relative paths. In case of a relative path a link will be created to the best match for that type with regard to its scope inside the project.
NOTE: Using relative paths could generate broken links if there are different data types with the same name inside the project!
For both types of links
LINK_TEXT is optional and it can be used to show a user defined text instead of link's path.
JavaDoc Autocomplete and Comment Templates
To add JavaDoc like comments to code,
in Code Editor type above the code declaration /** and then press Enter. Depending on the code type (a class declaration, a function, a task etc.) a comment will be added with the respective JavaDoc tags.
These comments are added based on some predefined comment templates that can be customized.
Go to
Window > Preferences > DVT > SystemVerilog > Editor > Code Templates.You can select a
javadoc template and modify it by adding/removing supported tags (using this naming convention:
${TagNameWithout@} ) or custom text.
You can also create new templates. A template will be applied only to a specified data type, for example:
javadoc_class will be applied to
classes. If you want to add a template for modules its name must respect the following rule:
YourTemplateName_DataType (ex:
MyModuleTemplate_module) and must be placed in
JavaDoc Comment Context.
See the result in the image below: