Home Page   We Generate Your Software.
Products Services Company Technology Demo Contact Site Map Search
Please note: this document is currently under revision.
The information herein contained, while still valid, does not reflect the latest state of the described technology.
The Somusar/SoProTech[tm] Booklet Series
Volume III

"somusar/Sisendel: A Tutorial Introduction"

Printer friendly

1. Introduction
2. Sisendel Software Entities
3. Sisendel Basic Types
4. Sisendel User Types
5. Contents of an Entity File
6. Section CORE
7. Section DEFS
8. Section DB
9. Section LOGIC
10. Section UI
11. Implicit Section DOC
11.1 Applying an HTML documentation mold
12. Section ADJUST
13. Further Reading

Chapter 11 - Implicit Section DOC

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.

11.1 - Applying an HTML documentation mold        top

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
Figure 5 - Example of generated document

[Previous chapter]    [Next chapter]    [Back to top]

http:// www.somusar.com  / doc  / booklets  / sisendel_tut  - Powered by SoProMach
Copyright © 2003-2012 Somusar - Trademarks - Legal - Privacy - Webmaster