Download BACHELOR THESIS
Transcript
script for turning both the classical JavaScript code and widget factory code (see Section 3.4 for details) to a pseudo-C# code understood by Doxygen. Formatting accepted by this pre-processing script is identical to the PHP code documentation formatting, except for a few details, e.g. @tparam is used for adding types to the method arguments, instead of @param. Having a common documentation for the whole project could quickly make it incomprehensible with the increasing project size. To prevent this, a combination of two mechanisms is used. On the top level, the documentation is separated into "modules" (Doxygen constructs). Each module has its own documentation page explaining its purpose and basic functionality. Entities such as namespaces or classes can be linked to modules. The second mechanism is a coordinated use of namespaces across the whole project. A common namespace asm is used for the whole project (except for widgets) and the second namespace level is used to distinguish parts of the project and link them to modules. By virtue of Doxygen's extensive set of features, the main page with project description is a part of the documentation as well as the whole User manual. This makes it possible to publish all project documentation together and to maintain it very easily. 58