Adjusted Documentation so javadoc would build
This commit is contained in:
parent
a655df2e41
commit
8ee8cd6e4d
@ -112,6 +112,8 @@ public class Timer {
|
||||
|
||||
/**
|
||||
* Checks if all humans have already voted, returns true if so, else returns false
|
||||
* @param game the game this is called in
|
||||
* @return returns true if all humans have voted
|
||||
*/
|
||||
public static boolean haveAllHumansVoted(Game game) {
|
||||
boolean[] whoHasVoted = game.getGameState().getClientVoteData().getHasVoted();
|
||||
|
||||
@ -44,6 +44,7 @@ public class OgGhostHighScore {
|
||||
/**
|
||||
* adds the given name to the list of og ghost winners and updates the file listing the og ghost
|
||||
* winners via writeOgGhostWinnersToFile
|
||||
* @param name the name of the OG Winner
|
||||
*/
|
||||
public static void addOgGhostWinner(String name){
|
||||
ogGhostWinners.add(name);
|
||||
@ -52,7 +53,7 @@ public class OgGhostHighScore {
|
||||
|
||||
/**
|
||||
* outputs the highscore list as it could be shown to clients.
|
||||
* @return
|
||||
* @return a well formated list in a String
|
||||
*/
|
||||
public static String formatGhostHighscoreList() {
|
||||
|
||||
@ -90,6 +91,7 @@ public class OgGhostHighScore {
|
||||
|
||||
/**
|
||||
* reads the highscore file (or if not yet present create it) and reads the ogGhostWinners;
|
||||
* @param args The system arguments, parsed as a string
|
||||
*/
|
||||
public static void main(String[] args) {
|
||||
try {
|
||||
|
||||
@ -151,15 +151,7 @@ public class Client {
|
||||
//LOGGER.debug("just checked next line");
|
||||
}
|
||||
|
||||
/**
|
||||
* Extracts infromation about names and positions and roles from string and adds it to the
|
||||
* GameStateModel
|
||||
*
|
||||
* @param msg
|
||||
*/
|
||||
public void gameStateModelSetter(String msg) {
|
||||
|
||||
}
|
||||
|
||||
public void setPosition(int position) {
|
||||
this.position = position;
|
||||
@ -341,7 +333,7 @@ public class Client {
|
||||
* @param parameter a string according to {@link GuiParameters} and {@link ClientGameInfoHandler}
|
||||
* can be empty
|
||||
* @param data some information in a string, separators can be $ or :
|
||||
* TODO(Seraina&Sebi): evtl. auslagern?
|
||||
* TODO(Seraina Sebi): evtl. auslagern?
|
||||
*/
|
||||
public void sendToGUI(String parameter, String data) {
|
||||
try {
|
||||
@ -349,7 +341,7 @@ public class Client {
|
||||
LOGGER.debug("GUI: PARAMETER:" + parameter + ", DATA: " + data);
|
||||
}
|
||||
switch (parameter) {
|
||||
case GuiParameters.night: //ClientGameInfoHandler
|
||||
case GuiParameters.night: //ClientGameInfoHandler;
|
||||
gameStateModel.setDayClone(false);
|
||||
chatApp.getGameController().setNoiseButtonInvisible();
|
||||
break;
|
||||
|
||||
@ -358,8 +358,8 @@ public class LoungeSceneViewController implements Initializable {
|
||||
/**
|
||||
* Adds players to a lobby
|
||||
* "NMEMB" {@link ch.unibas.dmi.dbis.cs108.multiplayer.helpers.GuiParameters}
|
||||
* @param lobbyID
|
||||
* @param player
|
||||
* @param lobbyID the Id the Player belongs to
|
||||
* @param player the player to be added
|
||||
*/
|
||||
public void addPlayerToLobby(String lobbyID, String player) {
|
||||
LOGGER.debug("Lobby ID: " + lobbyID + " player: " + player);
|
||||
@ -383,8 +383,8 @@ public class LoungeSceneViewController implements Initializable {
|
||||
* Used when a new lobby shall be added to the view. "NLOBBY" {@link
|
||||
* ch.unibas.dmi.dbis.cs108.multiplayer.helpers.GuiParameters}
|
||||
*
|
||||
* @param lobbyID
|
||||
* @param adminName
|
||||
* @param lobbyID the ID of the new lobby
|
||||
* @param adminName the name of the Lobby admin
|
||||
*/
|
||||
public void newLobby(String lobbyID, String adminName) {
|
||||
LobbyListView = lListView;
|
||||
@ -440,7 +440,7 @@ public class LoungeSceneViewController implements Initializable {
|
||||
/**
|
||||
* Used to add a new player to the list of players. "NPLOS" {@link ch.unibas.dmi.dbis.cs108.multiplayer.helpers.GuiParameters}
|
||||
*
|
||||
* @param s
|
||||
* @param s the information corresponding to to the client in String from
|
||||
*/
|
||||
public void addClientToList(String s) {
|
||||
ClientListItem cl = new ClientListItem(s);
|
||||
|
||||
@ -11,7 +11,7 @@ import javafx.scene.paint.Color;
|
||||
import javafx.scene.text.Text;
|
||||
|
||||
/**
|
||||
* Provides utilities to configure Labels for the ChatView {@see ch.unibas.dmi.dbis.cs108.multiplayer.client.gui.chat.ChatView.fxml}
|
||||
* Provides utilities to configure Labels for the ChatView {@code ChatView.fxml}
|
||||
* within {@link ch.unibas.dmi.dbis.cs108.multiplayer.client.gui.chat.ChatController}
|
||||
*/
|
||||
public class ChatLabelConfigurator {
|
||||
|
||||
Reference in New Issue
Block a user