Chapter 13. Documentation Generation (UMLdoc)

Table of Contents
UMLdoc
Code generation settings
Supported javadoc tags

To write documentation for a model element, select the documentation tab in the Details pane. When you have imported Java source code, the javadoc contained in the source code is imported too and is viewed in the documentation tab. When working with text based IDEs, you put your javadoc in doc comments (/** */). When using Poseidon's HTML editor, this is not necessary. The doc comments are added automatically to your source code when you generate it.

Figure 13-1. Editing a method documentation.

UMLdoc

The UMLdoc Plug-in generates HTML documentation files, that look similar to Javadoc. But it includes your UML diagrams as jpeg images, and offers an improved navigation. Currently UMLdoc generates documentation for models, packages, classes, interfaces, operations, methods, associations, actors, use cases, extend and include relationships.