Jump to: navigation, search

Tigerstripe Documentation Generation

Revision as of 06:23, 11 June 2008 by Dkeysell.cisco.com (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

The Tigerstripe Documentation Generator generates HTML documenation of a Tigerstripe model. An index page is generated that includes links to page:

- per model package
- for all Data Types
- for all Enumerations
- for all Notifications
- for all Exceptions
- for all Queries
- for all Update procedures

The per package pages contain details of all the artifacts within the package including Sessions, Managed Entities, Associations, Association Classes and Dependencies.

The index page also a contains view of:

- the package hierarchy of the model
- the inheritance hierarchy of each Managed Entity
- the Managed Entities that implement Interfaces and the operations by those Interfaces

Global Properties

outputDir: The output directory to which the HTML is generated can be configured using this property.