Editing Documentation

Select any of:

A class, by selecting it in the Package Browser.
A component, by selecting it in the diagram or in the Component Browser.
Note: You display the documentation of the component´s class, there is no specific component´s documentation.

Click Documentation Editor

.

The documentation of the class appears in a new tab in the Documentation Editor.

Note: If a Documentation Editor is already open, the new tab appears in that editor, otherwise a new Documentation Editor appears, containing the new tab.

Select the desired editor mode from the first top toolbar.


Normal text editor modes
Info Editor
Revisions Editor


HTML text editor modes
Info Source
Revisions Source

Edit the text from the text editor pane.

Note: Only a class denoted by a green open padlock

can be edited. To unlock a class, click the red padlock

.

To format the text, use the commands available in the second top toolbar.

You can use the blue arrows to navigate through the previous and next documentation pages.

To see the resulting documentation, click Formatted Documentation

.

Click OK to save and close the Documentation Editor.

Important:

You save the changes for all unsaved tabs in the editor.
If you have opened the Documentation Editor from a selected component and edited the component´s class, when closing this editor, you are in this activated class.