Javadoc @return markers

Customizing Javadoc documentation

Javadoc @return markers are used in the generation of Java documentation for return parameters that have Javadoc notes.

If you want the information contained in Javadoc notes on return parameters to appear in the generated Java documentation, you must specify this when configuring Objecteering Java Developer parameters (as shown in Figure 79 below).

Figure 79. Parameterizing generation of Javadoc notes on return parameters in Java documentation

Steps:

1. Select the "Documentation" set of parameters.

2. Check the "Generate Javadoc notes for return parameters" tickbox.

Javadoc notes entered for return parameters will now be generated in Java documentation.

Entering Javadoc notes on return parameters

To enter Javadoc notes on return parameters, the "Javadoc" field in the "Java" tab of the auxiliary window is used (as shown in Figure 80).

Figure 80. Entering a Javadoc note for a return parameter

Steps:

1. In the explorer, select the return parameter for which you wish to enter a Javadoc note.

2. Click on the "Java" tab of the auxiliary window.

3. In the "Javadoc" field, enter the contents of the Javadoc note.

The result of the operations shown in Figures 79 and 80 is shown in Figure 81 below.

Figure 81. Extracts from generated Javadoc documentation and the generated source file

The information you entered in the Javadoc note zone of the auxiliary window is presented in the generated documentation. It is introduced by the "Returns" title, followed by the description of the return parameter.

The same information is present in the generated source file, preceded by the @return marker.