From e4a1246f01c2a017042a2a80cc2e9a1e6b4bbd51 Mon Sep 17 00:00:00 2001
From: Ida Massow <massow@informatik.uni-luebeck.de>
Date: Sun, 29 May 2011 20:36:26 +0200
Subject: Viele Warnings durch Kommentare beseitigt

git-svn-id: svn://sunsvr01.isp.uni-luebeck.de/swproj13/trunk@312 72836036-5685-4462-b002-a69064685172
---
 src/jrummikub/control/ApplicationControl.java |  4 ----
 src/jrummikub/control/GameControl.java        |  5 +++++
 src/jrummikub/control/RoundControl.java       |  1 -
 src/jrummikub/model/StoneHeap.java            | 11 ++++++++---
 src/jrummikub/view/IView.java                 | 17 +++++++++++++++++
 5 files changed, 30 insertions(+), 8 deletions(-)

(limited to 'src')

diff --git a/src/jrummikub/control/ApplicationControl.java b/src/jrummikub/control/ApplicationControl.java
index 582a08c..88c04e3 100644
--- a/src/jrummikub/control/ApplicationControl.java
+++ b/src/jrummikub/control/ApplicationControl.java
@@ -1,10 +1,6 @@
 package jrummikub.control;
 
-import java.util.ArrayList;
-import java.util.List;
-
 import jrummikub.model.GameSettings;
-import jrummikub.util.Connection;
 import jrummikub.util.IListener;
 import jrummikub.util.IListener1;
 import jrummikub.view.IView;
diff --git a/src/jrummikub/control/GameControl.java b/src/jrummikub/control/GameControl.java
index 9e967c4..9eb9fa6 100644
--- a/src/jrummikub/control/GameControl.java
+++ b/src/jrummikub/control/GameControl.java
@@ -64,6 +64,11 @@ public class GameControl {
 		}));
 	}
 
+	/**
+	 * Is emitted when the user ends the game and start a new one
+	 * 
+	 * @return the endOfGameEvent
+	 */
 	public IEvent getEndOfGameEvent() {
 		return endOfGameEvent;
 	}
diff --git a/src/jrummikub/control/RoundControl.java b/src/jrummikub/control/RoundControl.java
index 1dcd5e8..fbe5873 100644
--- a/src/jrummikub/control/RoundControl.java
+++ b/src/jrummikub/control/RoundControl.java
@@ -5,7 +5,6 @@ import java.util.HashSet;
 import java.util.List;
 import java.util.Set;
 
-import jrummikub.control.turn.HumanTurnControl;
 import jrummikub.control.turn.ITurnControl;
 import jrummikub.model.Hand;
 import jrummikub.model.IHand;
diff --git a/src/jrummikub/model/StoneHeap.java b/src/jrummikub/model/StoneHeap.java
index 12dcc21..241cbc7 100644
--- a/src/jrummikub/model/StoneHeap.java
+++ b/src/jrummikub/model/StoneHeap.java
@@ -15,8 +15,13 @@ import java.util.Random;
 public class StoneHeap {
 	List<Stone> heap;
 	private Random generator = new Random();
-	
-	/** Creates 106 Stones according to standard rules */
+
+	/**
+	 * Creates 106 Stones according to standard rules
+	 * 
+	 * @param gameSettings
+	 *            (for number of sets/jokers, colors etc.)
+	 * */
 	public StoneHeap(GameSettings gameSettings) {
 		heap = new ArrayList<Stone>();
 		for (int i = 1; i <= 13; i++) {
@@ -35,7 +40,7 @@ public class StoneHeap {
 		jokerColors.set(3, temp);
 		
 		int jokersLeft = gameSettings.getJokerNumber();
-		done : while(true) {
+		done: while (true) {
 			for (StoneColor c : jokerColors) {
 				if (jokersLeft == 0)
 					break done;
diff --git a/src/jrummikub/view/IView.java b/src/jrummikub/view/IView.java
index b1241c7..12475b5 100644
--- a/src/jrummikub/view/IView.java
+++ b/src/jrummikub/view/IView.java
@@ -112,9 +112,26 @@ public interface IView {
 	 */
 	public void showScorePanel(boolean show);
 
+	/**
+	 * Is used for the PlayerPanel and ScorePanel to display a player's color
+	 * along with the name
+	 * 
+	 * @param color
+	 */
 	public void setCurrentPlayerColor(Color color);
 
+	/**
+	 * Is used for the PlayerPanel to display if a player has laid out along
+	 * with the name
+	 * 
+	 * @param hasLaidOut
+	 */
 	public void setHasLaidOut(boolean hasLaidOut);
 
+	/**
+	 * Is emitted if the player wants to end the game and start a new one
+	 * 
+	 * @return newGameEvent
+	 */
 	IEvent getNewGameEvent();
 }
-- 
cgit v1.2.3