Fixed some comment and metrics warnings

git-svn-id: svn://sunsvr01.isp.uni-luebeck.de/swproj13/trunk@552 72836036-5685-4462-b002-a69064685172
This commit is contained in:
Jannis Harder 2011-06-21 18:51:23 +02:00
parent 2a553fe6a5
commit d09041304b
8 changed files with 179 additions and 120 deletions

View file

@ -19,12 +19,12 @@ public interface ITurnControl {
* Start the turn
*
* @param info
* the current turn state
* the current turn state
*
* @param settings
* the game settings
* the game settings
* @param view
* view for user interaction.
* view for user interaction.
*/
public void setup(TurnInfo info, GameSettings settings, IView view);
@ -60,7 +60,8 @@ public interface ITurnControl {
public IEvent1<ITable> getTableUpdateEvent();
/**
* The TurnInfo class encapsulates all information concerning the current turn
* The TurnInfo class encapsulates all information concerning the current
* turn
*/
public class TurnInfo {
private IRoundState roundState;
@ -78,12 +79,15 @@ public interface ITurnControl {
/**
* Creates a new TurnInfo instance
*
* @param hasLaidOut
* has the player laid out yet?
* @param roundState
* current round state
* @param turnMode
* the turn mode
* the turn mode
* @param mayPause
* player is allowed to paues
*/
public TurnInfo(IRoundState roundState, TurnMode turnMode, boolean mayPause) {
public TurnInfo(IRoundState roundState, TurnMode turnMode,
boolean mayPause) {
this.roundState = roundState;
oldTable = roundState.getTable();
@ -97,6 +101,11 @@ public interface ITurnControl {
this.mayPause = mayPause;
}
/**
* Get the current round state
*
* @return the current round state
*/
public IRoundState getRoundState() {
return roundState;
}
@ -155,6 +164,11 @@ public interface ITurnControl {
return turnMode;
}
/**
* Return whether pausing is allowed during this turn
*
* @return true if pause is allowed
*/
public boolean isMayPause() {
return mayPause;
}