docs(plugin): clean up AbstractClient documentation

Author: xeruf

plugin/src/client/sc/plugin2020/AbstractClient.java

@@ -24,26 +24,24 @@
 public abstract class AbstractClient implements ILobbyClientListener {
   private static final Logger logger = LoggerFactory.getLogger(AbstractClient.class);
 
-  /** The handler reacts to messages from the server received by the lobby client */
+  /** The handler reacts to messages from the server received by the lobby client. */
   protected IGameHandler handler;
 
-  /** The lobby client, that connects to the room */
+  /** The lobby client that connects to the room. */
   private LobbyClient client;
 
   private String gameType;
 
-  /** If the client made an error (rule violation), store reason here */
+  /** If the client made an error (rule violation), store reason here. */
   private String error;
 
-  /** current id to identify the client instance internal */
+  /** Current id to identify the client instance internally. */
   private PlayerType id;
-  /** the current room in which the player is */
+  /** Current room of the player. */
   private String roomId;
-  /** the current host */
   private String host;
-  /** the current port */
   private int port;
-  /** current figurecolor to identify which client belongs to which player */
+  /** Current team color to identify which client belongs to which player. */
   private Team color;
 
   public AbstractClient(String host, int port, PlayerType id) throws IOException {
@@ -71,18 +69,12 @@ public void setHandler(IGameHandler handler) {
     this.handler = handler;
   }
 
-  /**
-   * Tell this client to observe the game given by the preparation handler
-   *
-   * @return controllable game
-   */
+  /** Tell this client to observe the game given by the preparation handler. */
   public IControllableGame observeGame(PrepareGameProtocolMessage handle) {
     return this.client.observe(handle);
   }
 
-  /**
-   * Called when a new message is sent to the room, e.g. move requests
-   */
+  /** Called when a new message is sent to the room, e.g. move requests. */
   @Override
   public void onRoomMessage(String roomId, Object data) {
     if(data instanceof MoveRequest) {
@@ -93,16 +85,12 @@ public void onRoomMessage(String roomId, Object data) {
     this.roomId = roomId;
   }
 
-  /**
-   * sends the <code>move</code> to the server
-   *
-   * @param move the move you want to do
-   */
+  /** Sends the <code>move</code> to the server. */
   public void sendMove(Move move) {
     this.client.sendMessageToRoom(this.roomId, move);
   }
 
-  /** Called when an error is sent to the room */
+  /** Called when an error is sent to the room. */
   @Override
   public void onError(String roomId, ProtocolErrorMessage response) {
     logger.debug("onError: Client {} received error {}", this, response.getMessage());

socha-sdk/src/server-api/sc/framework/plugins/Player.kt

@@ -50,8 +50,6 @@ open class Player @JvmOverloads constructor(
 
     fun hasHardTimeout() = hardTimeout
 
-    /** @return Reason for violation
-     */
     @XStreamOmitField
     var violationReason: String? = null