Login | Register
My pages Projects Community openCollabNet

13.4. Documentation Tab

Within the UML 1.4 standard, all model elements are children of the Element metaclass. The Element metaclass defines a tagged value documentation for comment, description or explanation of the element to which it is attached. Since this tagged value applies to every model element, it is given its own tab in the details pane, rather than being part of the Tagged Values tab.

Figure 13.7, “A typical Documentation tab on the details pane” shows a typical documentation tab for a model element in ArgoUML.

Figure 13.7. A typical Documentation tab on the details pane

A typical Documentation tab on the details pane

As you can see, many more fields have been added to the Documentation field alone. The other fields similarly store their information under tagged values: author, version, since, deprecated, see.

The fields on this tab are the same for all model elements.

Since UML comments are a kind of documentation, they are also shown on this tab, with name and body.

  • Author: A text box for the author of the documentation.

  • Version: A text box for the version of the documentation.

  • Since: A text box to show how long the documentation has been valid.

  • Deprecated: A check box to indicate whether this model element is deprecated (i.e. planned for removal in future versions of the design model).

  • See: Pointers to documentation outside the system.

  • Documentation: Literal text of any documentation.

  • Comment Name: The names of all comments attached to the modelelement.

  • Body: The bodies of all comments attached to this modelelement.

[Tip]Tip

ArgoUML is not primarily a documentation system. For model elements that require heavy documentation, notably use cases, the use of the See: field to point to external documents is more practical.