ExpressDoc

The ExpressDoc program generates documentation for each EXPRESS-schema, which is declared in the specified repository. ExpressDoc output files and directory structure is the same as generated by javadoc. Because of this reason the output of ExpressDoc and javadoc are used together. The displayed structure in a web-browser is also the same.

Program usage:

Program usage: java ExpressDoc options

Options:

-location xxx (the for repository containing express schemas)

-output xxx (the directory for the generated html files, usually this is "api")

-title xxx (the title of the schemas for which the documentation is generated)

-nojava (optional parameter, defines whether to generate java documentation for these schemas)

-complex_index (optional parameter, splits the index file into multiple files, alphabetically, one file per letter, plus a file for any index entries that start with non-alphabetical characters)

-complex_schema (listing of all schemas elements will be split alphabetically)

-include xxx {xxx} (for which models to generate documentation)

-exclude xxx {xxx} (for which models to skip documentation) 

The Structureof Generated Files and Directories:

These changes are done in the output directory:

�         lines added to the overview-frame.html:

Title

list of schemas

Index

�         express-indexX.html - index of all entity_definition's and defined_type's. X - the number increased for every index.

For every schema such structure is generated additionally:

Sschema_name

�         package-summary.html 

�         defined_type_name.html

�         entity_definition_name.html

Frame-set in web browser (how the view of the documentation is arranged):

list of packages from javadoc list of schemas and index from ExpressDoc	There is a detail documentation for every element you choose from the lower list on the left.
list of classes, interfaces, exceptions for javadoc case list of defined_types, entity_definitions and complex entities for ExpresDoc case