How This UMLdoc Is Organized

Overview

The Overview page is the front page of this UML document and can provide the following categories:

• Diagrams of the Model
• Diagram Summaries for every diagram category
• Package Summary
• Class Summary
• Interface Summary
• Actor Summary
• Use Case Summary
• Activity Summary

Package

Each package has a page that can contain the following categories:

• Diagrams of the Package
• Diagram Summaries for every diagram category
• Package Summary
• Class Summary
• Interface Summary
• Use Case Summary
• Actor Summary
• Activity Summary

Class

Interface

Actor

Use Case

Each classifier has its own separate page. Each of these pages has three sections consisting of a classifier description, summary tables, and detailed member descriptions:

• Classifier declaration
• Classifier description
• Direct Superclassifiers
• Direct Subclassifiers
• All Known Implementing Classifiers
• Diagrams describing the classifier

• Inner Classifier Summary
• Attribute Summary
• Association Summary
• Constructor Summary
• Method Summary

• Inner Classifier Detail
• Attribute Detail
• Association Detail
• Constructor Detail
• Method Detail

Each summary entry contains the first sentence from the detailed description for that item. All entries are alphabetical.

Tree (Inheritance Hierarchy)

There is an Inheritance Hierarchy page for the whole model. It contains a list of each: packages, classes, interfaces, actors and use cases. All elements are organized by inheritance structure starting with the model.

Index

The Index contains an alphabetic list of all classes, interfaces, actors, use cases, constructors, methods, attributes and diagrams. Each entry provides information about the respective package and to which class constructors, methods or attributes belong.

Frames / No Frames

These links show and hide the HTML frames. All pages are available with or without frames.