Free and Open Source real time strategy game with a new take on micro-management

Code Documentation

From Globulation2

Jump to: navigation, search

When doing documentation, a comment section for a function should look something like this:

/**
 * Any comments go here
 * @param string $foo 
 * @param int $bar
 * @return boolean
 * @access private
 * @todo document
 */

keep in mind not all of these items are always needed. if it doesn't take any parameters, that section is not needed.
so if it doesn't take any parameters, you can leave @param out