Skip to content

Commit 22f0f36

Browse files
committed
docs(network): fix some wordings
1 parent e723d5a commit 22f0f36

File tree

3 files changed

+6
-11
lines changed

3 files changed

+6
-11
lines changed

sdk/src/server-api/sc/networking/clients/XStreamClient.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -223,12 +223,12 @@ public DisconnectCause getDisconnectCause() {
223223
}
224224

225225
/**
226-
* Should be called when the client needs to be stopped and the disconnect
227-
* is initiated on this side. There are two situations where this should be
228-
* done:
226+
* Should be called when the client needs to be stopped
227+
* and the disconnect is initiated on this side.
228+
* There are two situations where this should be done:
229229
* <p>
230230
* - A game has ended
231-
* - An internal error occurred (this situation might be redundant)
231+
* - An error occurred
232232
*/
233233
public void stop() {
234234
// this side caused disconnect, notify other side

server/src/sc/server/gaming/GameRoom.java

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -261,11 +261,9 @@ private void startIfReady() {
261261
start();
262262
}
263263

264-
/** If the Game is prepared, sync all slots. */
265264
private synchronized void start() {
266265
setStatus(GameStatus.ACTIVE);
267266
this.game.start();
268-
269267
logger.info("Started {}", game);
270268
}
271269

@@ -441,10 +439,7 @@ public boolean isOver() {
441439
return getStatus() == GameStatus.OVER;
442440
}
443441

444-
/**
445-
* Return whether or not the game is paused or will be paused in the next turn.
446-
* Refer to {@link AbstractGame#isPaused()} for the current value.
447-
*/
442+
/** Return whether or not the game is paused or will be paused in the next turn. */
448443
public boolean isPauseRequested() {
449444
return this.pauseRequested;
450445
}

server/src/sc/server/network/Client.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
import java.util.List;
2222

2323
/**
24-
* A generic client. This represents a client in the server.
24+
* Represents a client in the server.
2525
*
2626
* Clients which connect to the server (as separate programs or running as threads started by the server)
2727
* are represented by {@link sc.networking.clients.LobbyClient}.

0 commit comments

Comments
 (0)