rsukkerd/Parallel-Bug-Fixes — Issue #4: Add class level comments to describe purpose of classes
Author: bestchai
Created: 2012-01-19 22:24:11+00:00
State: open

The current code lacks documentation. To start, add a javadoc comment block at the top of **every** class in the project. The comment should describe at the high level the purpose the class -- why it exists, what it is used for, and any notes on how to correctly use the class or common mistakes to avoid.

Here is an example class-level comment from a different project:

```java
/**
* This class implements the entry point to the application -- it contains the
* first method (onModuleLoad()) that will be run when the application is loaded
* by the browser. This class ties together the various application tabs, and is
* the central component through which functionality in different tabs
* communicate with each other.
*/
```