Description of a package

 

Contents

The description of a package contains:

·         a "Description" chapter

·         a "Use cases" chapter

·         an "Examples" chapter

·         an "Implementation" chapter

·         collaborations

·         state machines

·         activity graphs

·         classes

·         interfaces

·         components

·         nodes

·         referenced packages (only in HTML)

·         referenced classes (only in HTML)

·         referenced interfaces (only in HTML)

·         referenced components (only in HTML)

·         referenced nodes (only in HTML)

 

 

The "Description" chapter

This chapter contains:

·         the name of the owner package

·         "summary" and "description" notes

·         the list of tagged values

·         stereotypes

·         the list of constraints

·         the list of parent packages (with their "summary" notes)

·         the list of used packages (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 collaborations (with their "description" notes)

·         the list of state machines (with their "description" 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 use case diagrams (with their "description" notes), the list of actors (with their "summary" notes) and the list of use cases (with their "summary" notes)

·         actors

·         use cases

 

 

The "Examples" chapter

This chapter contains:

·         a "Description" chapter which allows you to display the list of instances (with their "summary" notes) and the object diagrams (with their "description" notes)

·         instances

 

 

The "Implementation" chapter

This chapter contains:

·         an "Architecture" chapter which allows you to display the list of nodes (with their "summary" notes), the list of components (with their "summary" notes) and the deployment diagrams (with their "description" notes).

·         an "Examples" chapter which allows you to display the list of node instances (with their "description" notes) and the list of component instances (with their "description" notes).

 

 

Example

 

Figure 25. Example of generating a package