Generating Java documentation

Generation

The javadoc tool can be launched on a class for which code has already been generated.

This feature uses the Javadoc type notes proposed for the model's classes, attributes, associations and operations.

You can decide whether a parameter should process description type notes in the same way as Javadoc type notes or not.

The produced HTML file is then opened by the editor designated by the "Command for editing HTML files" parameter.

Figure 23. Generating documentation

Steps:

1. In the explorer, right-click on the "BankAccount" class, to open the associated context menu.

2. Run the "Java Developer/Generate documentation" commands from the context menu which then appears.

The result is shown in Figure 24.

Figure 24. File edited by the "Generate documentation" command for the "BankAccount" class