1 // TEMPLATE FOR THE JAVADOC: USE <code></code> for code in comments
2 // YOU CAN USE HTML TAGS IN THE COMMENTS
5 * 1 LINE w/ A (.) AT THE END: BRIEF EXPLANATION (of the class, method, etc.)
7 * MULTIPLE LINES: IN-DEPTH EXPLANATION
9 * @param Param1Name (methods and constructors only)
11 * @param Param2Name (methods and constructors only)
13 * @return (methods-only when it actually returns something)
15 * @exception ExceptionName what exception does it throw?