Documenting UML model elements

In UML models, you can add detailed textual information to model elements. This text can include any information that you want to document, such as the role, purpose, or behavior of the model element.

Procedure

In the diagram editor, click a model element.
In the Properties view, click the Documentation tab.
On the Documentation page, type the appropriate text.

What to do next

The documentation page supports the Rich Text format. The action for creating a new line in the Rich Text Editor varies according to your operating system.

If you use Windows, perform these actions:

To create a new paragraph, press the Enter key.
To create a new line, press Shift+Enter.

If you use Linux, perform these actions:

To create a new line, press Enter or Shift+Enter.

Note:

Feedback