Javadoc @param markers

Customizing Javadoc documentation

Javadoc @param markers are used in the generation of Java documentation for parameters that have Javadoc notes. If you want the information contained in Javadoc notes on parameters to appear in the generated Java documentation, you must specify this when configuring Objecteering Java Developer parameters (as shown in Figure 76 below).

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

Steps:

1. Select the "Documentation" parameter set.

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

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

Entering Javadoc notes on parameters

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

Figure 77. Entering a Javadoc note for a parameter

Steps:

1. In the explorer, select the class 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 76 and 77 is shown in Figure 78 below.

Figure 78. 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 Java documentation. It is introduced by the "Parameters" title, followed by the name of the parameter and then its description.

The same information is present in the generated source file, preceded by first the @param marker and then the name of the parameter.