Code documentation
From Dokeos
The code documentation in Dokeos is written so that it can be automatically converted into a text or set of webpages by automated doc-generating tools like PhpDocumentor. The syntax for PhpDocumentor is very much like the JavaDoc syntax.
Not all functions are documented, but we aim for perfection, as always.
Current status of the documentation:
- All files (or 99% of them) have a package header, which means PhpDocumentor organises Dokeos code neatly into different packages.
- Many library functions have a function documentation header explainign what the function does. However, we could document them more extensively, document all parameters... this is the current area to focus on for documentation.
