Overview

Each FSW constituent defines and/or references some number of interfaces. The binary object files that are built from each constituent (for a given tag) contain link information that identifies these interfaces by name and version. Complicating the situation, an interface may be defined by more than one constituent and a constituent may define more than one interface.

The FSW Document Mechanization system harvests these object files each morning, then uses the information to generate sets of "constituent-interface diagrams", detailing each package/tag combination. These diagrams allow the user to see the relationships among a package's constituents, navigate between "constituent-" and "interface-centric" views, etc.

Details

• Each valid package/tag combination (with a few exceptions) has a pair of web pages, presenting constituent- and interface-centric views.

• Each of these pages depicts a package's constituents and (most) external constituents that are directly linked to them. Intervening interfaces are also depicted, as are any unused interfaces that the package's constituents define.

• Constituents are depicted as parallelograms; interfaces are depicted as rectangles (degenerating to squares when no label is present). Gray parallelograms are used for constituents in the current package.

• In constituent-centric pages, only the parallelograms are labeled. In interface-centric pages, only the rectangles are labeled. The connectivity, however, is exactly the same.

• Holding the cursor over any icon will produce a "tooltip".

• Clicking on icons generally takes you to a different view:

  • Clicking on an unlabeled icon takes you to a page where icons of that type are labeled.

  • Clicking on a white constituent icon takes you to a relationship page for that constituent's package (retaining the current view and tag).

  • Clicking on a gray constituent icon takes you to a constituent page (retaining the current tag).

• Each page's Legend gives information on the items in the diagram above.

• Finally, the "See Also" area at the top of each page will let you select a specified tag and view. The package page has a similar set of links.

Constituent-specific Diagrams

Each Constituent page contains a "local" subset of the Constituent-Interface diagram for its Package. In this subset, all icons are expanded. The semantics of icon clicking is somewhat different:

• Clicking on a white constituent icon takes you to the page for that constituent.

• Clicking on a white interface icon takes you to the page for a constituent that defines that interface.

• Clicking on a gray icon takes you to the relevant Doxygen "Interface" page.