Generating documentation

Documentation generation

The NDoc tool, which can be downloaded at http//sourceforge.net/projects/ndoc/, can be launched on any component for which code has been generated and compiled.

This feature uses the "CsSummary" and "CsRemarks" type notes which exist on the model's classes, attributes, associations and operations.

You can use the " "description" notes processed as "Csdoc" " parameter in the "Code generation" C# Developer parameter set to indicate whether "description" type notes should be processed in the same way as "csDoc" notes.

Figure 23. Generating documentation

Steps:

1. Right-click on the "BankApp" component in the explorer.

2. From the context menu, run the "MDA components/C# Developer/Documentation generation" command from the context menu that appears.

The following window then appears (Figure 24).

Figure 24. Window used to define the documentation to be generated

The result is shown in Figure 25.

Figure 25. File produced by the "Documentation generation" command on the "BankAccount" class in Javadoc-type documentation