Fixed all warnings (comments) but one, one TODO important

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

1 files changed, 31 insertions, 7 deletions

diff --git a/src/jrummikub/view/ISettingsPanel.java b/src/jrummikub/view/ISettingsPanel.java
index fbe1932..e76a3a2 100644
--- a/src/jrummikub/view/ISettingsPanel.java
+++ b/src/jrummikub/view/ISettingsPanel.java
@@ -36,8 +36,8 @@ public interface ISettingsPanel {
 	};
 
 	/**
-	 * The add player event is emitted when the user wants to add a player to the
-	 * player list
+	 * The add player event is emitted when the user wants to add a player to
+	 * the player list
 	 * 
 	 * @return the event
 	 */
@@ -83,12 +83,36 @@ public interface ISettingsPanel {
 	 */
 	public IEvent1<Integer> getChangeInitialMeldThresholdEvent();
 
+	/**
+	 * The change StoneSet number event is emitted when the user wants to use
+	 * more or less than 2 StoneSets per color
+	 * 
+	 * @return number of SoneSets
+	 */
 	public IEvent1<Integer> getChangeStoneSetNumberEvent();
 
+	/**
+	 * The change number of Stones dealt event is emitted when the user wants to
+	 * be dealt more or less than 14 Stones at the game start
+	 * 
+	 * @return number of Stones dealt
+	 */
 	public IEvent1<Integer> getChangeNumberOfStonesDealtEvent();
 
+	/**
+	 * The change highest value event is emitted when the user wants to set the
+	 * highest Stone value
+	 * 
+	 * @return highest Stone value
+	 */
 	public IEvent1<Integer> getChangeHighestValueEvent();
 
+	/**
+	 * The change Stone colors event is emitted when the user chooses the stone
+	 * colors to play with. Minimum 3, maximum 8
+	 * 
+	 * @return set of used StoneColors
+	 */
 	public IEvent1<Set<StoneColor>> getChangeStoneColorsEvent();
 
 	/**
@@ -102,7 +126,7 @@ public interface ISettingsPanel {
 	 * Sets an error to display
 	 * 
 	 * @param error
-	 *          the kind of error
+	 *            the kind of error
 	 */
 	public void setError(SettingsError error);
 
@@ -110,7 +134,7 @@ public interface ISettingsPanel {
 	 * Enables or disables the start game button
 	 * 
 	 * @param enable
-	 *          specifies if the button is to be enabled or disabled
+	 *            specifies if the button is to be enabled or disabled
 	 */
 	public void enableStartGameButton(boolean enable);
 
@@ -118,7 +142,7 @@ public interface ISettingsPanel {
 	 * Enables or disables the add player button
 	 * 
 	 * @param enable
-	 *          specifies if the button is to be enabled or disabled
+	 *            specifies if the button is to be enabled or disabled
 	 */
 	public void enableAddPlayerButton(boolean enable);
 
@@ -126,7 +150,7 @@ public interface ISettingsPanel {
 	 * Enables or disables the remove player buttons
 	 * 
 	 * @param enable
-	 *          specifies if the buttons are to be enabled or disabled
+	 *            specifies if the buttons are to be enabled or disabled
 	 */
 
 	public void enableRemovePlayerButtons(boolean enable);
@@ -135,7 +159,7 @@ public interface ISettingsPanel {
 	 * Sets the game settings to display
 	 * 
 	 * @param gameSettings
-	 *          the settings
+	 *            the settings
 	 */
 	public void setGameSettings(GameSettings gameSettings);