Commit 114a6553 authored by fmlab's avatar fmlab

fix a lot of checkstyle comments where a dot was missing

parent 5aad80a5
package gone.lib.common;
/**
* enum to store the different roles clients can have
* enum to store the different roles clients can have.
*
* @author winfried
*/
......
package gone.lib.common;
/**
* all compatible languages for the client/ui
* all compatible languages for the client/ui.
*
* @author matthias
*/
......
package gone.lib.common;
/**
* constant strings we regularly use for the network communication
* constant strings we regularly use for the network communication.
*
* @author Winfried
*/
......
package gone.lib.common;
/**
* store the different possible rc standards
* store the different possible rc standards.
*
* @author matthias
*/
......
......@@ -6,7 +6,7 @@ import gone.lib.common.RcStandard;
import java.net.InetAddress;
/**
* dataType which represents all configurable parameters for the client/ui
* dataType which represents all configurable parameters for the client/ui.
* @author matthias
*/
public class ClientConfig extends ConfigParameters {
......@@ -22,7 +22,7 @@ public class ClientConfig extends ConfigParameters {
/* constructor */
/**
* constructor
* constructor.
* @param width the width of the active window (ui)
* @param height the height of the active window (ui)
* @param warriorName the name of the warrior
......
package gone.lib.config;
/**
* parent class for server config and client config
* parent class for server config and client config.
*
* @author matthias
*/
......
package gone.lib.config;
/**
* possible configuration types
* possible configuration types.
*
* @author matthias
*/
......
......@@ -12,7 +12,7 @@ import java.util.prefs.InvalidPreferencesFormatException;
import java.util.prefs.Preferences;
/**
* loads the default/user config file (client, server)
* loads the default/user config file (client, server).
* the config file is stored as a preferences file (xml key=value, utf8)
* xml dtd used: http://java.sun.com/dtd/preferences.dtd
*
......@@ -24,8 +24,8 @@ public class LoadConfigFile {
/* constructor */
/**
* empty constructor, because we set the ConfigParameters variable
* later via a call to either loadClientPrefs or loadServerPrefs
* empty constructor, because we set the ConfigParameters variable later via a call to either loadClientPrefs or
* loadServerPrefs.
*/
public LoadConfigFile() {
this.configParameters = new ConfigParameters();
......@@ -40,7 +40,7 @@ public class LoadConfigFile {
/* class methods */
/**
* loads a client config pref file, transfer it into a intern ClientConfig object
* loads a client config pref file, transfer it into a intern ClientConfig object.
* @param defaultFilePath location of the default config file
* @param userFilePath location of the user config file
* @param configTypes type of the config to be loaded
......@@ -79,7 +79,7 @@ public class LoadConfigFile {
}
/**
* loads a server config pref file, transfer it into a intern ClientConfig object
* loads a server config pref file, transfer it into a intern ClientConfig object.
* @param path location of the config file
* @param configTypes type of the config to be loaded
* @throws IOException if the file is not found
......
......@@ -10,7 +10,7 @@ import java.util.prefs.BackingStoreException;
import java.util.prefs.Preferences;
/**
* updates the user config file with new values
* updates the user config file with new values.
* the config file is stored as a preferences file (xml key=value, utf8)
* xml dtd used: http://java.sun.com/dtd/preferences.dtd
*
......@@ -18,7 +18,7 @@ import java.util.prefs.Preferences;
*/
public class SaveConfigFile {
/**
* simply using the private save method, catch exceptions
* simply using the private save method, catch exceptions.
* @param actualParameters
* @param userFilePath
* @throws IOException
......@@ -33,8 +33,7 @@ public class SaveConfigFile {
}
/**
* transfer the config parameters to a preferences object and save this
* to the user config file
* transfer the config parameters to a preferences object and save this to the user config file.
* @param params our client config object that stores the actual parameters
* @param userFilePath location to save the config file
* @param nodeName string representing the config type
......@@ -80,8 +79,7 @@ public class SaveConfigFile {
}
/**
* transfer the config parameters to a preferences object and save this
* to the user config file
* transfer the config parameters to a preferences object and save this to the user config file.
* @param params our client config object that stores the actual parameters
* @param userFilePath location to save the config file
* @param nodeName string representing the config type
......
package gone.lib.config;
/**
* simple data type to store server config variables
* simple data type to store server config variables.
*
* @author matthias
*/
......
......@@ -14,7 +14,7 @@ import gone.lib.network.tcp.TcpClientModule;
import javax.naming.OperationNotSupportedException;
/**
* Created by winfr on 27.09.2016.
* @author winfried
*/
public class CwClient implements IClient, ITcpListener {
private IClientCallback callback;
......
......@@ -15,7 +15,7 @@ import gone.lib.network.tcp.TcpServerModule;
import javax.naming.OperationNotSupportedException;
/**
* Created by winfr on 27.09.2016.
* @author winfried
*/
public class CwServer implements IServer, ITcpListener {
private IServerCallback callback;
......
package gone.lib.network.json;
/**
* message type the clients receive if the game ends
* message type the clients receive if the game ends.
*
* @author winfried
*/
......
package gone.lib.network.json;
/**
* 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
* 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
*/
......
......@@ -3,8 +3,7 @@ package gone.lib.network.json;
import gone.lib.common.ClientRole;
/**
* message type that will be sent from the client to
* the server to establish a login on the server
* message type that will be sent from the client to the server to establish a login on the server.
*
* @author winfried
*/
......
......@@ -3,8 +3,7 @@ package gone.lib.network.json;
import gone.lib.common.RcStandard;
/**
* message type that receives the client from the server
* if the previous login of the client was successful
* message type that receives the client from the server if the previous login of the client was successful.
*
* @author winfried
*/
......
package gone.lib.network.json;
/**
* collection of the different message types including an
* unknown message type to deal with errors
* collection of the different message types including an unknown message type to deal with errors.
*
* @author winfried
*/
......
......@@ -3,8 +3,7 @@ package gone.lib.network.json;
import java.util.List;
/**
* message type to send the warrior code from the client
* to the server
* message type to send the warrior code from the client to the server.
*
* @author Winfried
*/
......
......@@ -3,9 +3,8 @@ package gone.lib.network.json;
import java.util.List;
/**
* message type to send the changes of the
* server core initiation and the count of the competing players
* from the server to the client
* 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
*/
......
......@@ -11,7 +11,7 @@ import gone.lib.network.json.CwStartContent;
import org.json.JSONStringer;
/**
* Created by winfr on 26.08.2016.
* @author winfried
*/
public class OutgoingMessagesSerializer {
private int packetVersion;
......
......@@ -7,8 +7,8 @@ import java.io.InputStreamReader;
import java.net.Socket;
/**
* Created by winfr on 26.08.2016.
* Represents an active connection to a client
* Represents an active connection to a client.
* @author Winfried
*/
public class TcpClientConnection {
/**
......
......@@ -12,7 +12,7 @@ import java.util.LinkedList;
import java.util.List;
/**
* Created by winfr on 26.09.2016.
* @author winfried
*/
public class TcpClientModule implements ITcpClientModule, ITcpListener {
private DataOutputStream outToServer;
......
......@@ -9,7 +9,7 @@ import java.util.LinkedList;
import java.util.List;
/**
* Created by Winfried on 23.09.2016.
* @author winfried
*/
public class TcpReceiveMessage implements Runnable {
private DataInputStream input;
......
......@@ -13,7 +13,7 @@ import java.util.HashMap;
import java.util.Map;
/**
* Created by Winfried on 23.09.2016.
* @author winfried
*/
public class TcpServerAccept implements Runnable {
private ITcpServerAccepted accepted;
......
......@@ -10,7 +10,7 @@ import java.util.LinkedList;
import java.util.List;
/**
* Created by Winfried on 23.09.2016.
* @author winfried
*/
public class TcpServerModule implements ITcpServerModule, ITcpServerAccepted, ITcpListener {
private List<ITcpListener> listeners = new LinkedList<>();
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment