Merge branch 'more-javadoccccc' into 'master'

More javadoccccc



See merge request !18

src/main/java/gone/lib/config/ClientConfig.java

@@ -7,7 +7,6 @@ import java.net.InetAddress;
 
 /**
  * dataType which represents all configurable parameters for the client/ui
- *
  * @author matthias
  */
 public class ClientConfig extends ConfigParameters {

src/main/java/gone/lib/network/CwClient.java

@@ -78,7 +78,7 @@ public class CwClient implements IClient, ITcpListener {
         } else if (type == CwMessageType.GameStatus) {
             callback.receiveGameStatusTelegram(interpreter.parseGameStatusMessage(data));
         } else if (type == CwMessageType.GameResult) {
-                callback.receiveGameResultTelegram(interpreter.parseGameResultMessage(data));
+            callback.receiveGameResultTelegram(interpreter.parseGameResultMessage(data));
         } else {
             // TODO: print that to log file
             System.out.print("unknown or invalid message type");

src/main/java/gone/lib/network/json/CwGameResultContent.java

 package gone.lib.network.json;
 
 /**
- * Created by winfr on 30.09.2016.
+ * message type the clients receive if the game ends
+ *
+ * @author winfried
  */
 public class CwGameResultContent {
     public String state;

src/main/java/gone/lib/network/json/CwGameStatusContent.java

 package gone.lib.network.json;
 
 /**
- * Created by winfr on 26.08.2016.
+ * message type that will be sent regularly from the server
+ * to the client, which represents the game update of one
+ * single game step at the server
+ *
+ * @author winfried
  */
 public class CwGameStatusContent {
     public int indexOfChangedCoreElement;

src/main/java/gone/lib/network/json/CwLoginContent.java

@@ -3,7 +3,10 @@ package gone.lib.network.json;
 import gone.lib.common.ClientRole;
 
 /**
- * Created by winfr on 23.08.2016.
+ * message type that will be sent from the client to
+ * the server to establish a login on the server
+ *
+ * @author winfried
  */
 public class CwLoginContent {
     public String name;

src/main/java/gone/lib/network/json/CwLoginOkContent.java

@@ -3,7 +3,10 @@ package gone.lib.network.json;
 import gone.lib.common.RcStandard;
 
 /**
- * Created by winfr on 27.09.2016.
+ * message type that receives the client from the server
+ * if the previous login of the client was successful
+ *
+ * @author winfried
  */
 public class CwLoginOkContent {
     public boolean clientMustWait;

src/main/java/gone/lib/network/json/CwMessageBase.java

-package gone.lib.network.json;
-
-/**
- * Created by winfr on 23.08.2016.
- */
-public class CwMessageBase {
-    public String packageType;
-    public int version;
-}

src/main/java/gone/lib/network/json/CwMessageType.java

 package gone.lib.network.json;
 
 /**
- * Created by winfr on 26.08.2016.
+ * collection of the different message types including an
+ * unknown message type to deal with errors
+ *
+ * @author winfried
  */
 public enum CwMessageType {
     Login,

src/main/java/gone/lib/network/json/CwReadyContent.java

@@ -3,7 +3,10 @@ package gone.lib.network.json;
 import java.util.List;
 
 /**
- * Created by Winfried on 22.09.2016.
+ * message type to send the warrior code from the client
+ * to the server
+ *
+ * @author Winfried
  */
 public class CwReadyContent {
     public List<String> warriorRedcode;

src/main/java/gone/lib/network/json/CwStartContent.java

@@ -3,7 +3,11 @@ package gone.lib.network.json;
 import java.util.List;
 
 /**
- * Created by winfr on 26.08.2016.
+ * message type to send the changes of the
+ * server core initiation and the count of the competing players
+ * from the server to the client
+ *
+ * @author winfried
  */
 public class CwStartContent {
     public int players;

src/main/java/gone/lib/network/serialization/IncomingMessagesInterpreter.java

@@ -23,9 +23,17 @@ import java.util.LinkedList;
 import java.util.List;
 
 /**
- * Created by winfr on 23.08.2016.
+ * this class
+ *
+ * @author winfried
  */
 public class IncomingMessagesInterpreter {
+
+    /**
+     *
+     * @param data
+     * @return
+     */
     public CwMessageType getMessageType(String data) {
         JSONObject object = new JSONObject(data);
 
@@ -42,7 +50,6 @@ public class IncomingMessagesInterpreter {
         } else if (object.getString("packageType").equals("finish")) {
             return CwMessageType.GameResult;
         }
-
         return CwMessageType.Unknown;
     }
 
@@ -58,7 +65,6 @@ public class IncomingMessagesInterpreter {
         } else if (object.getJSONObject("content").getString("standard").equals("Viewer")) {
             result.role = ClientRole.Viewer;
         }
-
         return result;
     }
 
@@ -68,7 +74,6 @@ public class IncomingMessagesInterpreter {
 
         CwStartContent result = new CwStartContent();
 
-
         String[] fullStateArray = object.getJSONObject("content")
                 .getString("fullState").split(NetworkConstants.FULLSTATESEPARATOR);
         List<String> fullStateList = new LinkedList<>();
@@ -95,7 +100,6 @@ public class IncomingMessagesInterpreter {
         } else if (object.getJSONObject("content").getString("standard").equals("ICWS94")) {
             result.standard = RcStandard.ICWS94;
         }
-
         return result;
     }
 

src/main/java/gone/lib/network/tcp/TcpClientModule.java

@@ -20,6 +20,11 @@ public class TcpClientModule implements ITcpClientModule, ITcpListener {
     private Socket clientSocket;
     private List<ITcpListener> listeners = new LinkedList<>();
 
+    /**
+     * connects to a remote server
+     * @param address
+     * @param port
+     */
     @Override
     public void connect(String address, int port) {
         try {

src/main/java/gone/lib/network/tcp/TcpReceiveMessage.java

@@ -27,6 +27,9 @@ public class TcpReceiveMessage implements Runnable {
         listeners.add(listener);
     }
 
+    /**
+     * Asynchronously receives incoming messages
+     */
     @Override
     public void run() {
         try {

src/main/java/gone/lib/network/tcp/TcpServerAccept.java

@@ -28,6 +28,9 @@ public class TcpServerAccept implements Runnable {
         this.accepted = accepted;
     }
 
+    /**
+     * Asynchronously wait for incoming clients
+     */
     @Override
     public void run() {
         try {