telephone: +61 3 9553 8008

javadoc.module

javadoc.module generates elegant functional XHTML documentation from Perl, PHP, Javascript or Java source code. The module is implemented as a perl script, so to use it you must have perl installed on your local computer.

javadoc.module makes use of documentation comments in your source code which follow the "Javadocs" standard published and maintained by Sun Microsystems. An example of a function documented in this manner is:

/**
 * Returns the capability for a given capability name.
 *
 * @author Modulus Pty. Ltd. - prh
 * @version 2008 1.0
 * @param $id  unique string id of the device
 * @param $name string name of the capability
 * @param $fallback boolean for considering fallback
 * @param @fallbackChain array of strings, where known, provide this to avoid unnecessary repetitive lookups
 * @return string capability
*/
function lib_getCapability($id, $name, $fallback, $fallbackChain)
{ 
	... 
} 

This documentation is immediately useful in the source code for developers maintaining or altering the source code. However, you may wish to publish an API to your functional library without publishing the source code. To do this, simply run javadoc.module on the source code to produce elegant, valid and conformant XHTML documentation as per the following example: