Fixed some comment and metrics warnings

git-svn-id: svn://sunsvr01.isp.uni-luebeck.de/swproj13/trunk@552 72836036-5685-4462-b002-a69064685172

1 files changed, 59 insertions, 43 deletions

diff --git a/src/jrummikub/control/RoundControl.java b/src/jrummikub/control/RoundControl.java
index c15eff7..7f3135a 100644
--- a/src/jrummikub/control/RoundControl.java
+++ b/src/jrummikub/control/RoundControl.java
@@ -44,19 +44,20 @@ public class RoundControl {
 		/** There are invalid set(s) on the table */
 		INVALID_SETS,
 		/**
-		 * The player tried to modify the table without providing the initial meld
-		 * threshold first
+		 * The player tried to modify the table without providing the initial
+		 * meld threshold first
 		 */
 		INITIAL_MELD_ERROR,
 		/**
-		 * The player didn't provide enough points for the initial meld threshold
+		 * The player didn't provide enough points for the initial meld
+		 * threshold
 		 */
 		NOT_ENOUGH_POINTS
 	}
 
 	/**
-	 * Table, stone sets and type of an invalid turn to allow a user to track his
-	 * own errors
+	 * Table, stone sets and type of an invalid turn to allow a user to track
+	 * his own errors
 	 */
 	public static class InvalidTurnInfo implements Serializable {
 		private static final long serialVersionUID = -3591000741414366776L;
@@ -69,11 +70,11 @@ public class RoundControl {
 		 * Creates new InvalidTurnInfo
 		 * 
 		 * @param table
-		 *          the table after the turn
+		 *            the table after the turn
 		 * @param type
-		 *          the type of the invalid turn
+		 *            the type of the invalid turn
 		 * @param invalidSets
-		 *          the sets causing the turn to be invalid
+		 *            the sets causing the turn to be invalid
 		 */
 		public InvalidTurnInfo(ITable table, InvalidTurnType type,
 				Collection<StoneSet> invalidSets) {
@@ -119,17 +120,27 @@ public class RoundControl {
 	protected List<Connection> connections = new ArrayList<Connection>();
 	private boolean mayPause;
 
+	/**
+	 * Create a new RoundControl using the given roundState and view
+	 * 
+	 * @param roundState
+	 *            initial round state
+	 * @param view
+	 *            view used for user interaction
+	 */
 	public RoundControl(IRoundState roundState, IView view) {
 		this(roundState, view, true);
 	}
 
 	/**
-	 * Create a new RoundControl using the given gameState and view
+	 * Create a new RoundControl using the given roundState and view
 	 * 
 	 * @param roundState
-	 *          initial round state
+	 *            initial round state
 	 * @param view
-	 *          view used for user interaction
+	 *            view used for user interaction
+	 * @param mayPause
+	 *            true when players are allowed to pause
 	 */
 	protected RoundControl(IRoundState roundState, IView view, boolean mayPause) {
 		this.roundState = roundState;
@@ -205,7 +216,7 @@ public class RoundControl {
 	 * Sets the current round state
 	 * 
 	 * @param state
-	 *          to be set
+	 *            to be set
 	 */
 	protected void setRoundState(IRoundState state) {
 		roundState = state;
@@ -244,11 +255,12 @@ public class RoundControl {
 		}
 
 		view.getTablePanel().setStoneSets(roundState.getTable().clone());
-		view.setCurrentPlayerName(roundState.getActivePlayer().getPlayerSettings()
-				.getName());
-		view.setCurrentPlayerColor(roundState.getActivePlayer().getPlayerSettings()
-				.getColor());
-		view.setCurrentPlayerHasLaidOut(roundState.getActivePlayer().getLaidOut());
+		view.setCurrentPlayerName(roundState.getActivePlayer()
+				.getPlayerSettings().getName());
+		view.setCurrentPlayerColor(roundState.getActivePlayer()
+				.getPlayerSettings().getColor());
+		view.setCurrentPlayerHasLaidOut(roundState.getActivePlayer()
+				.getLaidOut());
 
 		turnControl = createTurnControl(roundState.getActivePlayer()
 				.getPlayerSettings().getType());
@@ -284,9 +296,8 @@ public class RoundControl {
 			view.getPlayerPanel().setEndTurnMode(turnMode);
 		}
 
-		turnControl.setup(
-				new ITurnControl.TurnInfo(roundState, turnMode, mayPause),
-				roundState.getGameSettings(), view);
+		turnControl.setup(new ITurnControl.TurnInfo(roundState, turnMode,
+				mayPause), roundState.getGameSettings(), view);
 		turnControl.getEndOfTurnEvent().add(
 				new IListener2<IRoundState, InvalidTurnInfo>() {
 					@Override
@@ -327,7 +338,7 @@ public class RoundControl {
 	 * Override this
 	 * 
 	 * @param turnControl
-	 *          current turn control
+	 *            current turn control
 	 */
 	protected void addTurnControlListeners(ITurnControl turnControl) {
 	}
@@ -336,7 +347,7 @@ public class RoundControl {
 	 * Creates new turn control of the specified type
 	 * 
 	 * @param type
-	 *          of the new turn control
+	 *            of the new turn control
 	 * @return the new turn control
 	 */
 	protected ITurnControl createTurnControl(Type type) {
@@ -350,8 +361,10 @@ public class RoundControl {
 	protected void deal() {
 		for (int i = 0; i < roundState.getPlayerCount(); i++) {
 			IHand hand = roundState.getNthNextPlayer(i).getHand();
-			for (int j = 0; j < roundState.getGameSettings().getNumberOfStonesDealt(); j++) {
-				hand.drop(roundState.getGameHeap().drawStone(), new Position(0, 0));
+			for (int j = 0; j < roundState.getGameSettings()
+					.getNumberOfStonesDealt(); j++) {
+				hand.drop(roundState.getGameHeap().drawStone(), new Position(0,
+						0));
 			}
 		}
 
@@ -362,7 +375,7 @@ public class RoundControl {
 	 * End the players turn
 	 * 
 	 * @param invalidTurnInfo
-	 *          info about the player's last turn
+	 *            info about the player's last turn
 	 */
 	protected void endOfTurn(InvalidTurnInfo invalidTurnInfo) {
 		boolean isHuman = roundState.getActivePlayer().getPlayerSettings()
@@ -380,16 +393,16 @@ public class RoundControl {
 			view.setInvalidStoneSets(invalidTurnInfo.getInvalidSets());
 
 			switch (invalidTurnInfo.getType()) {
-				case INITIAL_MELD_ERROR:
-					view.setInitialMeldFirstError();
-					break;
-				case INVALID_SETS:
-					view.setStoneCollectionHidden(true);
-					break;
-				case NOT_ENOUGH_POINTS:
-					view.setInitialMeldError(roundState.getGameSettings()
-							.getInitialMeldThreshold());
-					break;
+			case INITIAL_MELD_ERROR:
+				view.setInitialMeldFirstError();
+				break;
+			case INVALID_SETS:
+				view.setStoneCollectionHidden(true);
+				break;
+			case NOT_ENOUGH_POINTS:
+				view.setInitialMeldError(roundState.getGameSettings()
+						.getInitialMeldThreshold());
+				break;
 			}
 
 			if (!isHuman) {
@@ -399,7 +412,8 @@ public class RoundControl {
 		}
 
 		view.setBottomPanel(BottomPanelType.NONHUMAN_HAND_PANEL);
-		view.getPlayerPanel().setTime(roundState.getGameSettings().getTotalTime(),
+		view.getPlayerPanel().setTime(
+				roundState.getGameSettings().getTotalTime(),
 				roundState.getGameSettings().getTotalTime());
 
 		nextPlayer();
@@ -487,10 +501,12 @@ public class RoundControl {
 				stonePoints = playerHand.isInitialMeldPossible(roundState
 						.getGameSettings()) ? 200 : 100;
 			} else {
-				stonePoints = playerHand.getStonePoints(roundState.getGameSettings());
+				stonePoints = playerHand.getStonePoints(roundState
+						.getGameSettings());
 			}
 
-			bestScore = updateBestScore(bestScore, -stonePoints, playerHand.getSize());
+			bestScore = updateBestScore(bestScore, -stonePoints,
+					playerHand.getSize());
 
 			points.add(-stonePoints);
 			pointSum += stonePoints;
@@ -514,11 +530,11 @@ public class RoundControl {
 	 * (everybody still has stones on hand)
 	 * 
 	 * @param bestScore
-	 *          of previous rounds
+	 *            of previous rounds
 	 * @param stonePoints
-	 *          sum of points still left on hands
+	 *            sum of points still left on hands
 	 * @param size
-	 *          number of players in game (= size of score list in columns)
+	 *            number of players in game (= size of score list in columns)
 	 * @return Pair of maximum points and hand size
 	 */
 	private static Pair<Integer, Integer> updateBestScore(
@@ -542,8 +558,8 @@ public class RoundControl {
 	}
 
 	/**
-	 * Redeal stones and restart round if a player was allowed to redeal and chose
-	 * to do so
+	 * Redeal stones and restart round if a player was allowed to redeal and
+	 * chose to do so
 	 */
 	private void redeal() {
 		turnControl = null;