Ticket #244 (new task)
Coding guidelines and code documentation through phpDocumentor
|Reported by:||DarTar||Owned by:||unassigned|
Description (last modified by BrianKoontz) (diff)
Since we are planning to use phpDocumentor to automatically generate a Wikka API documentation, all files, classes, functions and - where necessary - also variables and constants, should be documented trough the appropriate phpdoc comments. A basic guide on how to add phpDoc headers and comments can be found here. If you are already familiar with phpDoc syntax and wish to help documenting Wikka code, you can:
- check out the latest version of undocumented code from the repository;
- add the relevant phpdoc description and tags;
- upload it as an attachment to this ticket.
We will review it, merge it with the code and be eternally grateful :)
This ticket should also be used as a reference for works related to applying Wikka's coding guidelines.