Things to remember when writing JavaDoc:
Class declaration
/*** (Class name)** (Purpose of the class…)* <p>* (Copyright)* <p>* (License)** @author Edward Delaporte, Research Programmer, University of Illinois* @author (anyone else), Research Programmer, University of Illinois* <p>* Last updated by $Author$* @version $Revision$* <p>* Subversion URL: $URL$*/
Method block
- What it does.
- Parameters with @param variableName description
- Return type with @return description
- Possible exceptions with @throws, including known causes.
- Comment every control structure.
