Perl Development & Consultancy

Documentation generation

For a run-time linking and modular software design method using Microsoft Visual C++ a custom made documentation method was designed in Perl. Roughly based on JavaDoc and extended with special documentation directives to support the object orientated modular design used. The output consisted of an HTML page per module and handles referencing related modules using hypertext links. The Perl programming language was used to develop a program that could parse rapidly the source files and generate the required HTML files.

Because the documentation is part of the source files it is easier maintained and kept up to date.