The
ExpressDoc program generates documentation for each EXPRESS-schema, which is
declared in specified repository. ExpressDoc output files and directory structure
are same as generated by javadoc. Because of this the output of
ExpressDoc and javadoc are used together. Also the displayed structure in a
web-browser is same.
Program usage: java ExpressDoc options
-location
xxx (path where repository with contains schemas are located)
-output
xxx (directory where to output generated html files, usually this is
"api_ref")
-title
xxx (title of schemas for which documentation are generated)
-nojava (optional parameter, trigger generate java documentation
for schemas or not. Usually used for ARM schemas, because java classes are not
available for them)
-complex_index (index of these schemas will be split alphabetically)
-complex_schema (listing of all
schemas elements will be split alphabetically)
-include
xxx {xxx} (for which models generate documentation)
-exclude
xxx {xxx} (for which models skip documentation)
These
changes are done in output directory:
·
in
overview-frame.html added lines:
Title |
list
of schemas |
Index |
·
express-indexX.html
- index of all entity_definition's and defined_type's. X - number
increased for every index.
Additionally for every schema are generated such structure:
Sschema_name
·
package-summary.html
·
defined_type_name.html
·
entity_definition_name.html
|
There
is detail documentation for every element you choose from left-down list. |
|