Usage instructions

From Docu Wiki

Using docu is all about putting special comments in the right places.

Example

For example:

/**
* This function adds up the total of foo and bar
*
* @param int $foo The first variable
* @param int $bar The second variable
* @return int The return value
**/
function add_foo_bar($foo, $bar) {
  return $foo + $bar;
}

This will result in the following documentation being generated for the function add_foo_bar:

• A description of "This function adds up the total of foo and bar"
• Two parameters:
  • $foo, of type int with description "The first variable"
  • $bar, of type int with description "The second variable"
• A return value, of type int with description "The return value"

The important part of the documentation is the JavaDoc tags. The @param and @return are both JavaDoc tags.

Javadoc tags

There are many supported JavaDoc tags in docu. Some tags support multiple tags (such as @param, wheres others only support a single tag (such as @return)

The viewer

The viewer allows the searching and viewing of documentation. Its fairly self-explanatory.