Yandrik/Gamelib
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

cleanup: improve javadoc comments

Browse Source
This commit is contained in:
punchready
2021-06-03 03:54:18 +02:00
parent f323873b39
commit f9837b4c28
10 changed files with 40 additions and 45 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
src/main/java/uulm/teamname/marvelous/gamelibrary/gamelogic/GameStateManager.java
View File

@ -11,7 +11,7 @@ class GameStateManager {
/** The managed {@link GameState} */
private final GameState state;
/** The queue of {@link Event}s to be applied during {@link Request} processing */
/** The queue of {@link Event Events} to be applied during {@link Request} processing */
private final ArrayList<Event> queue = new ArrayList<>();
/**
@ -23,7 +23,7 @@ class GameStateManager {
}
/**
* Checks a list of {@link Request}s for validity and optionally produces resulting {@link Event}s.
* Checks a list of {@link Request Requests} for validity and optionally produces resulting {@link Event Events}.
* @param requests The requests to check
* @param apply True if resulting events should be stored for later application
* @return Whether the requests are valid
@ -50,7 +50,7 @@ class GameStateManager {
}
/**
* Applies an array of {@link Event}s to the game state.
* Applies an array of {@link Event Events} to the game state.
* @param events The events to apply
*/
public void applyEvents(Event[] events) {
@ -60,7 +60,7 @@ class GameStateManager {
}
/**
* Applies an array of {@link Event}s to the game state.
* Applies an array of {@link Event Events} to the game state.
* @param events The events to apply
*/
public void applyEvents(ArrayList<Event> events) {
@ -96,7 +96,7 @@ class GameStateManager {
/**
* Handles events that happen after a turn phase.
* @return The optionally resulting {@link Event}s
* @return The optionally resulting {@link Event Events}
*/
public ArrayList<Event> checkPostPhase() {
ArrayList<Event> result = GameLogic.checkTurnEnd(state);
@ -108,7 +108,7 @@ class GameStateManager {
* Initializes and starts the game.
* @param selectedCharacters1 The characters selected by player 1
* @param selectedCharacters2 The characters selected by player 2
* @return The resulting {@link Event}s
* @return The resulting {@link Event Events}
*/
public ArrayList<Event> startGame(ArrayList<Integer> selectedCharacters1, ArrayList<Integer> selectedCharacters2) {
ArrayList<Event> result = GameLogic.startGame(state, selectedCharacters1, selectedCharacters2);
@ -124,7 +124,7 @@ class GameStateManager {
/**
* Forcefully ends the current turn.
* @return The resulting {@link Event}s
* @return The resulting {@link Event Events}
*/
public ArrayList<Event> endTurn() {
ArrayList<Event> result = GameLogic.endTurn(state);