Within the UML 1.4 standard, all artifacts are children of
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 artifact, it is given its own tab in the details pane, rather
than being part of the
Figure 13.7, “A typical Documentation tab on the details pane” shows a typical documentation tab for an artifact in ArgoUML.
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:
The fields on this tab are the same for all artifacts.
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
Version: A text box for the version of
Since: A text box to show how long the
documentation has been valid.
Deprecated: A check box to indicate
whether this artifact is deprecated (i.e. planned for removal in
future versions of the design model).
See: Pointers to documentation outside
Documentation: Literal text of any
Comment Name: The names of all comments
attached to the modelelement.
Body: The bodies of all comments attached
to this modelelement.
ArgoUML is not primarily a documentation system. For artifacts
that require heavy documentation, notably use cases, the use of the