Display the Documentation
You can display and edit the documentation of a class as text or as pure HTML. You can display the Documentation Editor from a class or from a selected component.
-
To display the documentation in the Documentation
Editor, do the following:
Tip: If you only want to display the documentation, not to edit it, you can also use the Documentation Viewer. For more information about the Documentation Viewer, see Displaying the Documentation in an Immersive Dockable Viewer. - To display it from a class:
- Select the class by, for example, clicking it in the Package Browser.
- From the Behavior Authoring section of the action bar, click
Documentation Editor
.
Tip: You can also access the command any of the following ways: - By right-clicking the class in the Package
Browser and select
Documentation Editor
.
- From the Action Pad panel. To
access the Action Pad panel,
from the Tools section of the
action bar, click
Action Pad
, or right-click an empty area and select Display > Action Pad.
- By right-clicking the class in the Package
Browser and select
Documentation Editor
- To display it from a component:
- Select the component in the diagram or in the Component Browser.
- From the context toolbar, click
Documentation Editor
.
Tip: You can also access the command in any of the following ways: - From the Behavior Authoring
section of the action bar, click
Documentation Editor
.
- By right-clicking the component in the diagram or in
the Component Browser and
select Documentation Editor
.
- From the Action Pad panel. To
access the Action Pad panel,
from the Tools section of the
action bar, click
Action Pad
, or right-click an empty area and select Display > Action Pad.
- From the Behavior Authoring
section of the action bar, click
Documentation Editor
Note: You display the documentation of the component´s class, there is no specific component´s documentation.
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.If a documentation already exists for the class, it is displayed.
If no documentation exists, you can create documentation.
The Documentation Editor contains:
- A first top toolbar for handling modes and classes.
- A second top toolbar that contains editor commands for the text editor.
- A header that is the comment from the class definition.
- The Information section. This section may be edited if the class is not locked.
- Some other sectors, for example, Parameters and Connectors that come from the names and comments from parameter definitions.
- The Revisions section, if revision documentation is present. This section may be edited if the class is not locked.
- A last section with class name, path, filename, and Uses.
- The OK, Apply All, and Cancel commands.
- To display it from a class:
- Optional:
For the tab, you can right-click the tab header and do any of:
- Close to close the tab.
- Detach in New Window to open a new Documentation Editor and display the tab in that editor.
- Optional:
To display the
Information section or the
Revisions section only, in text format in a
text editor, do the following:
- To display the
Information section, in the top toolbar,
click
Info Editor
.
- To display the
Revisions section, in the top toolbar,
click
Revisions Editor
.
The selected section appears in a text editor in the Documentation Editor. - To display the
Information section, in the top toolbar,
click
Info Editor
- Optional:
To display the
Information section or the
Revisions section only, as pure HTML text,
do the following:
- To display the
Information section, in the top toolbar,
click
Info Source
.
- To display the
Revisions section, in the top toolbar,
click
Revisions Source
.
The selected section appears as pure HTML text in the Documentation Editor. - To display the
Information section, in the top toolbar,
click
Info Source
-
To return to displaying the full documentation, in the top
toolbar, click
Formatted Documentation
.