The next @see form directs readers to a specific package: com.magic.attr.
The final two forms allow you to reference other documentation. The first defines a link using <a...>. The
second uses quotes to enclose the name of the document. You might use these to direct readers to other
documentation, such as the full specification.
The @see forms that name a language entity (any of the above forms except the last two) can have a label
following the entity. This label name will be the one used in the generated documentation instead of the
entity's name. For example,
@see #getName Attribute Names
will create a link to the documentation of getName but will display the text "AttributeNames" not
"getName". You should usually let the actual member name be used, but occasionally you may find this
feature useful.
19.2.2. {@link} and {@linkplain}
The @see tag is useful for a "See also" section at the end of the documentation. You can embed an {@link}
in-line tag in your text when the cross reference should belong in the text of your comment. The syntax for
@link is
{@link package.class#member [label]}
The identifier specification is the same as for @see, as is the optional label. The following sentence
embeds a link to the getValue method:
Changes the value returned by calls to {@link #getValue}.
The {@linkplain} tag acts just like {@link} except that the generated text uses a plain font rather code
font. This is useful for replacing the link with a label that consists of plain text.
19.2.3. @param
The @param tag documents a single parameter to a method or constructor, or else a type parameter in a class,
interface, or generic method. If you use @param tags you should have one for each parameter of the method.
The first word of the paragraph is taken as the parameter name, and the rest is its description:
@param max The maximum number of words to read.
When documenting type parameters you should use < and > around the type parameter name:
@param