Perfecting comments to be able to create a javadoc.

This commit is contained in:
2006-01-10 15:39:55 +00:00
parent 5373eaf0aa
commit d2c08d60c5
5 changed files with 186 additions and 80 deletions

View File

@ -7,33 +7,34 @@ import suicideChess.Move.NotAValidMoveException;
import suicideChess.Square.NotAValidSquare;
/**
* @author djib
*
* Main File
*
* $LastChangedDate$
* $LastChangedRevision$
* $LastChangedBy$
* Main file (the game in itself)
* @author Jean-Baptiste Hétier
* @version $LastChangedRevision$, $LastChangedDate$
*/
public class SuicideChess {
/**
/*
* Those flags are used to perform extra checks during the debugging of the
* program. They may be safely all set to false once the program is stable.
* It should improve performance a lot.
*/
//does BitBoard.class removePiece function checks if removing piece is legal ?
/**
* does BitBoard.class removePiece function checks if removing piece is legal ?
*/
public static final boolean BITBOARD_REMOVEPIECE_CHECK_REMOVE = true;
//does Square.class checks if the strings are valid (is "z9" a valid square ?
/**
* does Square.class checks if the strings are valid (is "z9" a valid square ?
*/
public static final boolean SQUARE_CHECK_INVALID = true;
private static final int MAIN_VERSION_NUMBER = 0;
private static final int REVISION_NUMBER = 15;
public static final int MAIN_VERSION_NUMBER = 0;
public static final int REVISION_NUMBER = 15;
/*****************
* MAIN FUNCTION *
*****************/
/**
* The main function
* @param args No parameters should be transmitted to this function.
*/
public static void main(String[] args) {
System.out.println("Welcome to SuicideChess v"+MAIN_VERSION_NUMBER+"."+REVISION_NUMBER+"!");
BufferedReader moveInput = new BufferedReader(new InputStreamReader(System.in));