Specador Documentation Generator User Guide
Rev. 24.1.12, 12 June 2024

7.3 JavaDoc

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.

@param Valid for: functions, tasks

Adds a parameter with the specified argument-name followed by the specified description to the "Arguments" section
@return Valid for: functions

Adds a "Returns" section with the description text. This text should describe the return type and permissible range of values
@see Adds a "See Also" heading with a link or text entry that points to reference. A doc comment may contain any number of @see tags, all grouped under the same heading
@author Adds an "Author" entry
@deprecated Adds a comment indicating that this API should no longer be used (even though it may continue to work)
@version Adds a "Version" subheading with the specified version-text
@since Adds a "Since" heading with the specified since-text
{@link LINK_ADDRESS LINK_TEXT} Inserts an in-line link with visible text label that points to the documentation for the specified package, class or member name of a referenced class. This tag is valid in all doc comments. For more details see below.
{@literal text} Displays text without interpreting the text as HTML markup or nested javadoc tags. This enables you to use regular angle brackets (< and >) instead of the HTML entities (<and >) in doc comments, such as in parameter types (<Object>), inequalities (3 < 4), or arrows (<-)

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.