How This UML Report Document Is Organized

Overview

The Overview page is the front page of this report document and provides a list of all packages with a summary for each. This page can also contain an overall description of the set of packages.

Package

Each package has a page that contains a list of its classes, interfaces and other elements, with a summary for each. This page can contain categories in below order:

• Interface
• Class
• Derivation Classifier
• DataType
• Enumeration
• StereoType
• Activity
• Actor
• Node
• Source File Artifact
• UseCase
• ActivityGroup
• FinalNode
• FinalState
• ForkNode
• InitialNode
• InvacationNode
• LifeLine

Element

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

• Class inheritance diagram
• Direct Subclasses
• All Known Subinterfaces
• All Known Implementing Classes
• Class/interface declaration
• Class/interface description

• Nested Class Summary
• Attribute Summary
• Constructor Summary
• Operation Summary
• Stereotype Summary
• Tagged Value Summary
• Constraint Summary
• Diagram Summary

• Attribute Detail
• Constructor Detail
• Operation Detail

Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.

Diagram

Each diagram has a page to display its image in jpg format. Clicking on an element on full digram page will take you to the element detail page.