Specador Documentation Generator User Guide
Rev. 24.2.24, 14 October 2024
| Javadoc syntax relies on specific tags to guide how information is displayed in the generated documentation. These tags can offer insights into your code's functionality, can facilitate documentation organization, and can enable linking to other elements.
The table below lists the JavaDoc tags that Specador 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}. These links can point to data inside Documentation. In this case LINK_ADDRESS must respect the following notation: Package_Name::Class_Name.Method_Name for an absolute path or 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! LINK_TEXT is optional and it can be used to show a user defined text instead of link's path. |