Program Description

DocsMaker scans and analyzes the source code in the interface description language, IDL, thus obtaining names of interfaces, methods, etc. described in the code. Those essences are then, with the reference to their inter-dependence, included in an extensive xml document that stores the hierarchy of relations between the essences. Also, the document contains additional information on the project, code examples, descriptions and comments on the program's objects. That document will become the foundation for the creation of the HTML files. The next step in using the DocsMaker is applying the so-called xsl-conversion to the xml document. The conversion lies in the serial DocsMaker of *.xsl templates with configurable internal parameters to document. The results of these steps will be the *.htm files organized in a certain hierarchy and containing cross links between them. Besides that, the DocsMaker generates and prepares HTML Help project files (*.hhc,*.hhk,*.hhp), which you can use to build a documentation file in the *chm format with, for instance, Microsoft HTML Help Workshop. Besides program's objects, you can include in the help file your own descriptions like comments to interface or methods, purpose, peculiarities of calling, returned values, etc.