|
Sequence Diagram Editor Top Previous Next |
| Each diagram element can be associated with a documentation note which provides additional information for the diagram element. Element documentation notes are different from flow notes because they are associated directly with a diagram element. If displayed, they are always displayed immediately before their associated element and move automatically when the element is moved.
|
|
|
| Element documentation notes can also be printed and exported separately from the diagram to provide additional documentation or they can be shown as part of the diagram itself.
|
|
|
| Diagram element documentation notes can typically be entered directly into the element's input form while it is being added or modified. They can also be edited separately in a documentation window by invoking the Edit Documentation command from the diagram menu (Diagram | Edit Documentation...) while the diagram element is selected.
|
|
|
| The input form for diagram elements supporting documentation notes has a checkbox (Show Doc) that can be used to select whether the note should be displayed as part of the diagram or not (can be overridden by diagram properties).
|
|
|
| Documentation Note Tooltips
|
| Documentation notes can be displayed as tooltips by using the Element Documentation Tips command from the view menu (View | Element Documentation Tips.) When enabled, element documentation notes that are not already displayed in the diagram are shown as tooltips when the mouse hovers over the element. Note: Nothing is displayed if the documentation note is empty.
|
|
|
| See Also
|
| Diagram Tasks | Note Display Levels | Diagram Properties | Diagram Menu | Sequence Diagram Elements | Printing Documentation Notes | Exporting Diagrams
|
|
|