5 files changed, 62 insertions, 5 deletions

diff --git a/src/main/java/module-info.java b/src/main/java/module-info.java
new file mode 100644
index 00000000..c0b567e1
--- /dev/null
+++ b/src/main/java/module-info.java
@@ -0,0 +1,8 @@
+/**
+ * Utilities for Torchlight II modding
+ * @author bjcul
+ *
+ */
+module tlIITools {
+	exports tlIItools;
+}
\ No newline at end of file
diff --git a/src/main/java/tlIItools/AffixGroup.java b/src/main/java/tlIItools/AffixGroup.java
index 5835614d..9f6bf788 100644
--- a/src/main/java/tlIItools/AffixGroup.java
+++ b/src/main/java/tlIItools/AffixGroup.java
@@ -12,6 +12,9 @@ import tlIItools.Affix.*;
  *
  * @author Ben Culkin */
 public class AffixGroup implements Comparable<AffixGroup> {
+    /**
+     * Contains all of the effects in this affix group
+     */
     public List<EffectGroup> effects;
     /** The types of enchanters who can add this. */
     public List<String> enchantSources;
@@ -50,6 +53,11 @@ public class AffixGroup implements Comparable<AffixGroup> {
         return afx.toAffixGroup().equals(this);
     }
     
+    /**
+     * Get a summary of the effects of this group.
+     * 
+     * @return A string summarizing the effects in this group
+     */
 	public String groupSummary() {
 		StringBuilder sb = new StringBuilder();
 
diff --git a/src/main/java/tlIItools/EffectGroup.java b/src/main/java/tlIItools/EffectGroup.java
index 9f4ad49b..4cbbc0a1 100644
--- a/src/main/java/tlIItools/EffectGroup.java
+++ b/src/main/java/tlIItools/EffectGroup.java
@@ -32,6 +32,11 @@ public class EffectGroup {
     /** Whether or not this effect is a 'transfer' effect (Applied to the enemy on a hit). */
     public boolean isTransfer;
     
+    /**
+     * Retrieve a summary of this effect group.
+     * 
+     * @return A summary of the effect group
+     */
 	public String summary() {
 		StringBuilder sb = new StringBuilder();
 		
diff --git a/src/main/java/tlIItools/LevelRange.java b/src/main/java/tlIItools/LevelRange.java
index b0d620bf..0cc803dd 100644
--- a/src/main/java/tlIItools/LevelRange.java
+++ b/src/main/java/tlIItools/LevelRange.java
@@ -2,6 +2,12 @@ package tlIItools;
 
 import java.util.*;
 
+/**
+ * Represents a range of levels.
+ * 
+ * @author bjcul
+ *
+ */
 public class LevelRange implements Comparable<LevelRange> {
 	/*
 	 * if (minLevel <= 1 && maxLevel == 999) {
@@ -19,14 +25,29 @@ public class LevelRange implements Comparable<LevelRange> {
 	 * sb.append(minLevel);
 	 * } */
 
+	/**
+	 * The maximum level for this range.
+	 */
 	public int minLevel;
+	/**
+	 * The minimum level for this range.
+	 */
 	public int maxLevel;
 
+	/**
+	 * Create a new blank level range
+	 */
 	public LevelRange() {
 		minLevel = 1;
 		maxLevel = 999;
 	}
 
+	/**
+	 * Create a new set level range.
+	 * 
+	 * @param minLevel The minimum level
+	 * @param maxLevel The maximum level
+	 */
 	public LevelRange(int minLevel, int maxLevel) {
 		this.minLevel = minLevel;
 		this.maxLevel = maxLevel;
@@ -37,14 +58,29 @@ public class LevelRange implements Comparable<LevelRange> {
 		maxLevel = Math.min(999, maxLevel);
 	}
 
+	/**
+	 * Check if this level range is 'unrestricted'
+	 * 
+	 * @return Whether the level range is unrestricted
+	 */
 	public boolean isUnrestricted() {
 		return minLevel <= 1 && maxLevel >= 999;
 	}
 
+	/**
+	 * Check if this range has no lower bound
+	 * 
+	 * @return Whether the range has no lower bound
+	 */
 	public boolean noLowerBound() {
 		return minLevel <= 1;
 	}
 
+	/**
+	 * Check if this range has no upper bound
+	 * 
+	 * @return Whether the range has no upper bound
+	 */
 	public boolean noUpperBound() {
 		return maxLevel >= 999;
 	}
@@ -118,18 +154,16 @@ public class LevelRange implements Comparable<LevelRange> {
 		if (noLowerBound()) {
 		        if (other.noLowerBound()) {
 		            return maxLevel - other.maxLevel;
-		        } else {
-		            return -1;
 		        }
+				return -1;
 		} else if (noUpperBound()) {
 			if (other.noUpperBound()) {
 				return minLevel - other.minLevel;
-			} else {
-				return 1;
 			}
+			return 1;
 		} else {
 			if (minLevel == other.minLevel) return maxLevel - other.maxLevel;
-			else                            return minLevel - other.minLevel;
+			return minLevel - other.minLevel;
 		}
 	}
 }
diff --git a/src/main/java/tlIItools/NameFileReader.java b/src/main/java/tlIItools/NameFileReader.java
index a9646942..a0593c28 100644
--- a/src/main/java/tlIItools/NameFileReader.java
+++ b/src/main/java/tlIItools/NameFileReader.java
@@ -80,6 +80,8 @@ public class NameFileReader {
 	 *
 	 * @param r The input source to read from. */
 	public void readFrom(Reader r) {
+		// the caller will take care of it
+		@SuppressWarnings("resource")
 		Scanner scn = new Scanner(r);
 
 		while (scn.hasNextLine()) {