Documentation

Writing Documentation

Writing good documentation is essential to the success of any software project. 
The quality of documentation can be even more important than the quality of the 
code itself, as a good first impression will prompt developers to look further 
into your code 

( phpdoc)

As also described in the DeveloperFAQ page, we are using tools for generating documentation from the source code. For the PHP source code, we are using  phpDocumentor, so please take a look at the official  quickstart document. The JavaScript documentation tool e are using is  JSDoc, which has similiar syntax to phpdoc - see the  tag reference. Also, remember to add the name of your file to the JS_LOCAL variable in www/include/js/Makeconf. For Java application we use  Javadoc.

Generating Documentation in PHP projects

At the root of the project type

• make jsdoc - generate javascript documentation
• make phpdoc - generate php documentation
• make doc - generate both documentations
• make clean_doc - remove the documentation

The php/js documentation is generated under docs/{phpdocs,jsdocs} respectively.

Generating Document in Java project

• set up a build.xml and allow to call ant javadoc