diff --git a/src/main/java/net/knarcraft/minecraftserverlauncher/profile/Profile.java b/src/main/java/net/knarcraft/minecraftserverlauncher/profile/Profile.java index d23fb0a..5c2b075 100644 --- a/src/main/java/net/knarcraft/minecraftserverlauncher/profile/Profile.java +++ b/src/main/java/net/knarcraft/minecraftserverlauncher/profile/Profile.java @@ -12,7 +12,7 @@ import java.io.*; import java.util.ArrayList; /** - * Contains all user settings, and a list of servers. + * Keeps track of a set of servers and some user settings * * @author Kristian Knarvik * @version 1.0.0 @@ -41,9 +41,9 @@ public class Profile { /** * Instantiates a new profile * - * @param name

The name of the profile

+ * @param name

The name of the profile

* @param runInBackground

Whether to run the software in the background the next time it starts

- * @param delayStartup

Whether to delay the startup of servers

+ * @param delayStartup

Whether to delay the startup of servers

*/ private Profile(String name, boolean runInBackground, int delayStartup) { this.collections = new ArrayList<>(); @@ -65,7 +65,7 @@ public class Profile { /** * Gets whether the software should keep running in the background * - * @return

Whether the software should keep running in the backgound

+ * @return

Whether the software should keep running in the background

*/ public boolean getRunInBackground() { return this.runInBackground; @@ -83,7 +83,7 @@ public class Profile { /** * Gets the number of seconds to delay startup * - * @return

The number of seconds to delay starup

+ * @return

The number of seconds to delay startup

*/ public int getDelayStartup() { return this.delayStartup; @@ -119,10 +119,10 @@ public class Profile { } /** - * Gets a Collection object by name. + * Gets a collection given its name * - * @param name The name of the collection. - * @return A collection object. + * @param name

The name of the collection to get

+ * @return

A collection or null if no collection exists with the given name

*/ public Collection getCollection(String name) { for (Collection collection : this.collections) { @@ -134,9 +134,9 @@ public class Profile { } /** - * Adds a collection to the profile if the name is valid. + * Adds a collection to the profile if the name is valid * - * @param name The name of the collection and its elements. + * @param name

The name of the collection and its elements

*/ public void addCollection(String name) throws ConfigurationException { if (name == null) { //If a user cancels or crosses out window @@ -247,4 +247,5 @@ public class Profile { } return profile; } + } diff --git a/src/main/java/net/knarcraft/minecraftserverlauncher/server/servertypes/BungeeCord.java b/src/main/java/net/knarcraft/minecraftserverlauncher/server/servertypes/BungeeCord.java index a0b946b..5759212 100644 --- a/src/main/java/net/knarcraft/minecraftserverlauncher/server/servertypes/BungeeCord.java +++ b/src/main/java/net/knarcraft/minecraftserverlauncher/server/servertypes/BungeeCord.java @@ -10,6 +10,9 @@ import static net.knarcraft.minecraftserverlauncher.utility.CommonFunctions.down import static net.knarcraft.minecraftserverlauncher.utility.CommonFunctions.readFile; import static net.knarcraft.minecraftserverlauncher.utility.CommonFunctions.stringBetween; +/** + * This class represents the BungeeCord proxy server type + */ public class BungeeCord extends AbstractServerType { private final String versionURL; diff --git a/src/main/java/net/knarcraft/minecraftserverlauncher/server/servertypes/CraftBukkit.java b/src/main/java/net/knarcraft/minecraftserverlauncher/server/servertypes/CraftBukkit.java index 235d2ef..0f8967e 100644 --- a/src/main/java/net/knarcraft/minecraftserverlauncher/server/servertypes/CraftBukkit.java +++ b/src/main/java/net/knarcraft/minecraftserverlauncher/server/servertypes/CraftBukkit.java @@ -13,7 +13,7 @@ public class CraftBukkit extends AbstractServerType { private final String downloadURLPart; /** - * Instantiates a new server type + * Instantiates a new CraftBukkit server type * * @param typeName

The name of the server type

* @param isProxy

Whether this server type is a proxy server

diff --git a/src/main/java/net/knarcraft/minecraftserverlauncher/server/servertypes/Custom.java b/src/main/java/net/knarcraft/minecraftserverlauncher/server/servertypes/Custom.java index 814b7a9..6a0183b 100644 --- a/src/main/java/net/knarcraft/minecraftserverlauncher/server/servertypes/Custom.java +++ b/src/main/java/net/knarcraft/minecraftserverlauncher/server/servertypes/Custom.java @@ -4,9 +4,9 @@ import java.io.File; public class Custom extends AbstractServerType { /** - * Instantiates a new server type + * Instantiates a new custom server type * - * @param typeName

The name of the server type

+ * @param typeName

The name of the server type

*/ public Custom(String typeName) { super(typeName, false, new String[]{}, ""); diff --git a/src/main/java/net/knarcraft/minecraftserverlauncher/server/servertypes/MCPCPlus.java b/src/main/java/net/knarcraft/minecraftserverlauncher/server/servertypes/MCPCPlus.java index 5f0273f..4bf4c70 100644 --- a/src/main/java/net/knarcraft/minecraftserverlauncher/server/servertypes/MCPCPlus.java +++ b/src/main/java/net/knarcraft/minecraftserverlauncher/server/servertypes/MCPCPlus.java @@ -1,9 +1,12 @@ package net.knarcraft.minecraftserverlauncher.server.servertypes; +/** + * This class represents the MCPC+ Minecraft server type + */ public class MCPCPlus extends CraftBukkit { /** - * Instantiates a new server type + * Instantiates a new MCPCplus server type * * @param typeName

The name of the server type

* @param isProxy

Whether this server type is a proxy server

diff --git a/src/main/java/net/knarcraft/minecraftserverlauncher/server/servertypes/Paper.java b/src/main/java/net/knarcraft/minecraftserverlauncher/server/servertypes/Paper.java index 1da8c8c..3fb4021 100644 --- a/src/main/java/net/knarcraft/minecraftserverlauncher/server/servertypes/Paper.java +++ b/src/main/java/net/knarcraft/minecraftserverlauncher/server/servertypes/Paper.java @@ -1,11 +1,14 @@ package net.knarcraft.minecraftserverlauncher.server.servertypes; +/** + * This class represents the Paper Minecraft server type + */ public class Paper extends Spigot { /** - * Instantiates a new server type + * Instantiates a new Paper server type * - * @param typeName

The typeName of the server type

+ * @param typeName

The name of the server type

* @param isProxy

Whether this server type is a proxy server

* @param versions

A list of one or more server versions for the type

* @param downloadURL

The URL used for downloading .jar files

diff --git a/src/main/java/net/knarcraft/minecraftserverlauncher/server/servertypes/Spigot.java b/src/main/java/net/knarcraft/minecraftserverlauncher/server/servertypes/Spigot.java index 611ab2a..b63a3de 100644 --- a/src/main/java/net/knarcraft/minecraftserverlauncher/server/servertypes/Spigot.java +++ b/src/main/java/net/knarcraft/minecraftserverlauncher/server/servertypes/Spigot.java @@ -1,11 +1,14 @@ package net.knarcraft.minecraftserverlauncher.server.servertypes; +/** + * This class represents the CraftBukkit Minecraft server type + */ public class Spigot extends CraftBukkit { /** - * Instantiates a new server type + * Instantiates a new Spigot server type * - * @param typeName

The typeName of the server type

+ * @param typeName

The name of the server type

* @param isProxy

Whether this server type is a proxy server

* @param versions

A list of one or more server versions for the type

* @param downloadURL

The URL used for downloading .jar files

diff --git a/src/main/java/net/knarcraft/minecraftserverlauncher/server/servertypes/SpongeVanilla.java b/src/main/java/net/knarcraft/minecraftserverlauncher/server/servertypes/SpongeVanilla.java index ed18c15..89aefc3 100644 --- a/src/main/java/net/knarcraft/minecraftserverlauncher/server/servertypes/SpongeVanilla.java +++ b/src/main/java/net/knarcraft/minecraftserverlauncher/server/servertypes/SpongeVanilla.java @@ -9,6 +9,9 @@ import java.nio.file.Paths; import static net.knarcraft.minecraftserverlauncher.utility.CommonFunctions.downloadFile; +/** + * This class represents the SpongeVanilla Minecraft server type + */ public class SpongeVanilla extends AbstractServerType { private final String versionURL; diff --git a/src/main/java/net/knarcraft/minecraftserverlauncher/server/servertypes/Travertine.java b/src/main/java/net/knarcraft/minecraftserverlauncher/server/servertypes/Travertine.java index bebad43..b58f597 100644 --- a/src/main/java/net/knarcraft/minecraftserverlauncher/server/servertypes/Travertine.java +++ b/src/main/java/net/knarcraft/minecraftserverlauncher/server/servertypes/Travertine.java @@ -2,6 +2,9 @@ package net.knarcraft.minecraftserverlauncher.server.servertypes; import net.knarcraft.minecraftserverlauncher.server.ServerVersionContainer; +/** + * This class represents the Travertine proxy server type + */ public class Travertine extends Waterfall { /** diff --git a/src/main/java/net/knarcraft/minecraftserverlauncher/server/servertypes/Vanilla.java b/src/main/java/net/knarcraft/minecraftserverlauncher/server/servertypes/Vanilla.java index 76dabb1..9e05408 100644 --- a/src/main/java/net/knarcraft/minecraftserverlauncher/server/servertypes/Vanilla.java +++ b/src/main/java/net/knarcraft/minecraftserverlauncher/server/servertypes/Vanilla.java @@ -15,7 +15,7 @@ import static net.knarcraft.minecraftserverlauncher.utility.CommonFunctions.down import static net.knarcraft.minecraftserverlauncher.utility.CommonFunctions.readFile; /** - * This class represents the regular vanilla server type + * This class represents the regular vanilla Minecraft server type */ public class Vanilla extends AbstractServerType { diff --git a/src/main/java/net/knarcraft/minecraftserverlauncher/server/servertypes/Waterfall.java b/src/main/java/net/knarcraft/minecraftserverlauncher/server/servertypes/Waterfall.java index 3b8d247..0676a1b 100644 --- a/src/main/java/net/knarcraft/minecraftserverlauncher/server/servertypes/Waterfall.java +++ b/src/main/java/net/knarcraft/minecraftserverlauncher/server/servertypes/Waterfall.java @@ -11,6 +11,9 @@ import static net.knarcraft.minecraftserverlauncher.utility.CommonFunctions.down import static net.knarcraft.minecraftserverlauncher.utility.CommonFunctions.readFile; import static net.knarcraft.minecraftserverlauncher.utility.CommonFunctions.stringBetween; +/** + * This class represents the Travertine proxy server type + */ public class Waterfall extends AbstractServerType { private final String srcStart;