|
Although a project mold kit may contain one or more
molds for generatable documentation files, entity files do not contain any
DOC section. The reason for this is that
generatable documentation files should actually
describe and document the features and pecularities of
the files generated for sections CORE, DB, LOGIC
and UI.
The set of sample molds used for this booklet contains one DOC mold
that produces simple HTML documentation files listing several
features of a given entity. The following illustration
shows the documentation file produced for entity
"company/employee.ef"
. As the example shows, it is possible to generate several types
of technical documentation, ranging from API reference manuals,
to user's guides, to cross-reference tables.
Figure 5 - Example of generated document
[Previous chapter]
[Next chapter]
[Back to top]
|
