diff --git a/src/main/java/inf112/fiasko/roborally/utility/BoardLoaderUtil.java b/src/main/java/inf112/fiasko/roborally/utility/BoardLoaderUtil.java index af34d36..75f3377 100644 --- a/src/main/java/inf112/fiasko/roborally/utility/BoardLoaderUtil.java +++ b/src/main/java/inf112/fiasko/roborally/utility/BoardLoaderUtil.java @@ -14,7 +14,7 @@ import java.io.*; import java.util.List; /** - * Loads a board + * This class helps loading boards */ public final class BoardLoaderUtil { private BoardLoaderUtil() {} diff --git a/src/main/java/inf112/fiasko/roborally/utility/IOUtil.java b/src/main/java/inf112/fiasko/roborally/utility/IOUtil.java index f17f5d8..013f97f 100644 --- a/src/main/java/inf112/fiasko/roborally/utility/IOUtil.java +++ b/src/main/java/inf112/fiasko/roborally/utility/IOUtil.java @@ -10,10 +10,18 @@ import java.util.ArrayList; import java.util.List; import java.util.Map; +/** + * This class helps with tasks which mix primitive classes and classes from external libraries + */ public final class IOUtil { private IOUtil() {} - + /** + * Generates a list of players from a map of player names and a map of robot ids + * @param playerNames A map between connections and player names + * @param robotIDs A map between connections and robot ids + * @return A list of players + */ public static List playerGenerator(Map playerNames, Map robotIDs) { List playerList = new ArrayList<>(); for (Connection connection: playerNames.keySet()) { diff --git a/src/main/java/inf112/fiasko/roborally/utility/NetworkUtil.java b/src/main/java/inf112/fiasko/roborally/utility/NetworkUtil.java index 2d74663..8561507 100644 --- a/src/main/java/inf112/fiasko/roborally/utility/NetworkUtil.java +++ b/src/main/java/inf112/fiasko/roborally/utility/NetworkUtil.java @@ -10,6 +10,9 @@ import inf112.fiasko.roborally.objects.ProgrammingCard; import java.util.ArrayList; +/** + * This class helps with networking tasks + */ public final class NetworkUtil { /** diff --git a/src/main/java/inf112/fiasko/roborally/utility/ResourceUtil.java b/src/main/java/inf112/fiasko/roborally/utility/ResourceUtil.java index b4b6148..5e5a32c 100644 --- a/src/main/java/inf112/fiasko/roborally/utility/ResourceUtil.java +++ b/src/main/java/inf112/fiasko/roborally/utility/ResourceUtil.java @@ -2,6 +2,9 @@ package inf112.fiasko.roborally.utility; import java.io.InputStream; +/** + * This class helps with tasks related to resource loading + */ public final class ResourceUtil { private ResourceUtil() {}