javadoc.module

javadoc.module generates elegant functional XHTML documentation from Perl, PHP, Javascript or Java source code. javadoc.module can accept a local file as input or an URL. The returned text is neatly structured XHTML, which makes use of CSS to style the output; the javadoc comments can include HTML markup, which will be appropriately rendered. The option exists to return full HTML pages, or just a block of HTML-formatted text representing the javadoc comments, or even to return plain text with no HTML formatting. javadoc.module is a very efficient way to generate reference documentation for software libraries which can be directly posted to the Internet or an Intranet. The documentation is suits display on all modern browsers, including mobile devices. The module is written in PHP and is easily implemented.

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: