Description of a package
Contents
The description of a package contains:
· a "Description" chapter
· a "Use cases" chapter
· an "Examples" chapter
· referenced packages (only in HTML)
· referenced classes (only in HTML)
· referenced interfaces (only in HTML)
The "Description" chapter
This chapter contains:
· the name of the owner package
· the contents of the "summary" and "description" notes
· the list of parent packages (with their "summary" notes)
· the list of packages used (with their "summary" notes)
· class diagrams (with their "description" notes)
· invariants
· the list of enumerates (with their "description" notes)
· the list of types (with their "description" notes)
· the list of received dataflows (with their "description" notes)
· the list of sent dataflows (with their "description" notes)
· the list of packages (with their "summary" notes)
· the list of classes (with their "summary" notes)
· the list of interfaces (with their "summary" notes)
· the list of referenced elements (with their "summary" notes)
The "Use cases" chapter
This chapter contains:
· a "Description" chapter which allows you to display the use case diagrams (with their "description" notes), the list of actors (with their "summary" notes), the list of use cases (with their "summary" notes)
The "Examples" chapter
This chapter contains:
· a " Description " chapter, which allows you to display the list of instances (with their "description" notes), the object diagrams (with their "description" notes)