Tags

Lets you define custom tags that should be recognized by the Javadoc parser.

Javadoc

Lets you define custom Javadoc tags. You need to specify all non-standard tags that you use - i.e. all tags not defined in HTML 4.01 - in order to see the Javadoc parser behave correctly. Otherwise errors are generated for every tag that is unknown to the system.

Figure 2.80. Define Custom Javadoc Tags

Define Custom Javadoc Tags

Refer to the tables below to learn about the tags that are supported by default.

Block tags

Lets you define custom Javadoc block tags.

The table below shows the Javadoc block tags that are supported by default.

Table 2.4. Build-in Javadoc block tags

NameSince
@author1.0
@beaninfo1.0
@deprecated1.0
@exception1.0
@jalopy.group1.1
@jalopy.group-order1.1
@jalopy.group_order1.1
@param1.0
@return1.0
@see1.0
@serial1.0
@serialData1.0
@serialField1.0
@since1.0
@throws1.0
@todo1.0
@version1.0

Use the Add... and Remove buttons to add or remove items to and from the list.

Figure 2.81. Add new Block Tag

Add new Block Tag

Valid block tags have the form @[a-zA-Z]+, e.g. @pre.

In-line tags

Lets you define custom Javadoc in-line tags.

The table below shows the Javadoc in-line tags that are supported by default.

Table 2.5. Build-in Javadoc in-line tags

NameSince
@code1.3
@docRoot1.0
@inheritDoc1.0
@link1.0
@linkPlain1.0
@literal1.3
@value1.0

Use the Add... and Remove buttons to add or remove items to and from the list.

Figure 2.82. Add new In-line Tag

Add new In-line Tag

Valid in-line tags have the form @[a-zA-Z]+, e.g. @root.

Since 1.0