Description of a class or an interface

Contents

The description of a class contains:

· a " Description" chapter

· an "Examples" chapter

· collaborations

· state machines

· operations

· classes

· interfaces

Note: The generation of an interface is absolutely identical to the generation of a class. However, the main interface generation title is "Interface <className>" instead of "Class <className>".

The "Description" chapter

This chapter contains:

· the component name

· "summary" and "description" notes

· the list of parent classes

· invariants

· class diagrams (with their "description" notes)

· 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 operations (with their "summary" notes)

· the list of roles (with their "description" notes)

· the list of attributes (with their "description" notes)

· the list of classes (with their "summary" notes)

· the list of interfaces (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) and the object diagrams (with their "description" notes)

· instances