Repair/RepairCompiler/MCC/javadoc.template

   1 // TEMPLATE FOR THE JAVADOC: USE <code></code> for code in comments
   2 // YOU CAN USE HTML TAGS IN THE COMMENTS
   3
   4 /**
   5  *   1 LINE w/ A (.) AT THE END: BRIEF EXPLANATION (of the class, method, etc.)
   6  *
   7  *   MULTIPLE LINES: IN-DEPTH EXPLANATION
   8  *
   9  *  @param  Param1Name      (methods and constructors only)
  10  *                          explain parameter 1
  11  *  @param  Param2Name      (methods and constructors only)
  12  *                          explain parameter 2
  13  *  @return                 (methods-only when it actually returns something)
  14  *                           what do we return?
  15  *  @exception ExceptionName   what exception does it throw?
  16  *  @see       Function1Name
  17  *  @see       Function2Name
  18  */
  19
  20 //END OF TEMPLATE