Cleanup some warnings and stuff

5 files changed, 109 insertions, 18 deletions

diff --git a/src/main/java/bjc/everge/LogStream.java b/src/main/java/bjc/everge/LogStream.java
index 68bbf84..ef35d9b 100644
--- a/src/main/java/bjc/everge/LogStream.java
+++ b/src/main/java/bjc/everge/LogStream.java
@@ -164,56 +164,150 @@ public class LogStream {
 		}
 	}
 
+	/**
+	 * Print a formatted message at a given verbosity level.
+	 * 
+	 * @param lvl
+	 *             The verbosity level.
+	 * @param msg
+	 *             The message to print.
+	 * @param args
+	 *             The arguments to the message.
+	 */
 	public void messagef(int lvl, String msg, Object... args) {
 		if (verbosity >= lvl) {
 			output.printf(msg, args);
 		}
 	}
 
+	/**
+	 * Emit a fatal error message.
+	 * 
+	 * @param msg
+	 *            The message to emit.
+	 */
 	public void fatal(String msg) {
 		message(FATAL, msg);
 	}
 
+	/**
+	 * Emit a formatted fatal error message.
+	 * 
+	 * @param msg
+	 *             The message to emit.
+	 * @param args
+	 *             The arguments to the message.
+	 */
 	public void fatalf(String msg, Object... args) {
 		messagef(FATAL, msg, args);
 	}
 
+	/**
+	 * Emit a normal error message.
+	 * 
+	 * @param msg
+	 *            The message to emit.
+	 */
 	public void error(String msg) {
 		message(ERROR, msg);
 	}
 
+	/**
+	 * Emit a formatted normal error message.
+	 * 
+	 * @param msg
+	 *             The message to emit.
+	 * @param args
+	 *             The arguments to the message.
+	 */
 	public void errorf(String msg, Object... args) {
 		messagef(ERROR, msg, args);
 	}
 
+	/**
+	 * Emit a warning message.
+	 * 
+	 * @param msg
+	 *            The message to emit.
+	 */
 	public void warn(String msg) {
 		message(WARN, msg);
 	}
 
+	/**
+	 * Emit a formatted warning message.
+	 * 
+	 * @param msg
+	 *             The message to emit.
+	 * @param args
+	 *             The arguments to the message.
+	 */
 	public void warnf(String msg, Object... args) {
 		messagef(WARN, msg, args);
 	}
 
+	/**
+	 * Emit an info message.
+	 * 
+	 * @param msg
+	 *            The message to emit.
+	 */
 	public void info(String msg) {
 		message(INFO, msg);
 	}
 
+	/**
+	 * Emit a formatted info message.
+	 * 
+	 * @param msg
+	 *             The message to emit.
+	 * @param args
+	 *             The arguments to the message.
+	 */
 	public void infof(String msg, Object... args) {
 		messagef(INFO, msg, args);
 	}
 
+	/**
+	 * Emit a debug message.
+	 * 
+	 * @param msg
+	 *            The message to emit.
+	 */
 	public void debug(String msg) {
 		message(DEBUG, msg);
 	}
 
+	/**
+	 * Emit a formatted debug message.
+	 * 
+	 * @param msg
+	 *             The message to emit.
+	 * @param args
+	 *             The arguments to the message.
+	 */
 	public void debugf(String msg, Object... args) {
 		messagef(DEBUG, msg, args);
 	}
 
+	/**
+	 * Emit a tracing message.
+	 * 
+	 * @param msg
+	 *            The message to emit.
+	 */
 	public void trace(String msg) {
 		message(TRACE, msg);
 	}
 
+	/**
+	 * Emit a formatted tracing message.
+	 * 
+	 * @param msg
+	 *             The message to emit.
+	 * @param args
+	 *             The arguments to the message.
+	 */
 	public void tracef(String msg, Object... args) {
 		messagef(TRACE, msg, args);
 	}
diff --git a/src/main/java/bjc/everge/MirrorOutputStream.java b/src/main/java/bjc/everge/MirrorOutputStream.java
index 8c99cc9..bce4f0f 100644
--- a/src/main/java/bjc/everge/MirrorOutputStream.java
+++ b/src/main/java/bjc/everge/MirrorOutputStream.java
@@ -3,9 +3,21 @@ package bjc.everge;
 import java.io.*;
 import java.util.*;
 
+/**
+ * An output stream that mirrors its contents to other streams.
+ * 
+ * @author Ben Culkin
+ *
+ */
 public class MirrorOutputStream extends OutputStream {
 	private List<OutputStream> streams;
 
+	/**
+	 * Create a new mirroring output stream.
+	 * 
+	 * @param strams
+	 *               The output streams to mirror to.
+	 */
 	public MirrorOutputStream(OutputStream... strams) {
 		streams = new ArrayList<>();
 
diff --git a/src/test/java/bjc/everge/ReplPairTest.java b/src/test/java/bjc/everge/ReplPairTest.java
index c2a020c..6583855 100644
--- a/src/test/java/bjc/everge/ReplPairTest.java
+++ b/src/test/java/bjc/everge/ReplPairTest.java
@@ -17,6 +17,7 @@ import org.junit.Test;
  *
  * @author Ben Culkin
  */
+@SuppressWarnings("javadoc")
 public class ReplPairTest {
 	@Test
 	public void testLoadFile() {
diff --git a/src/test/java/bjc/everge/StringUtilsTest.java b/src/test/java/bjc/everge/StringUtilsTest.java
index 91af56e..92f6f2b 100644
--- a/src/test/java/bjc/everge/StringUtilsTest.java
+++ b/src/test/java/bjc/everge/StringUtilsTest.java
@@ -11,6 +11,7 @@ import static org.junit.Assert.*;
  *
  * @author Ben Culkin
  */
+@SuppressWarnings("javadoc")
 public class StringUtilsTest {
 	@Test
 	public void testNullSplit() {
diff --git a/src/test/java/bjc/everge/TestUtils.java b/src/test/java/bjc/everge/TestUtils.java
index 49e962e..b3ca419 100644
--- a/src/test/java/bjc/everge/TestUtils.java
+++ b/src/test/java/bjc/everge/TestUtils.java
@@ -16,29 +16,12 @@ import static org.junit.Assert.*;
  *
  * @author Ben Culkin
  */
+@SuppressWarnings("javadoc")
 public class TestUtils {
-	/**
-	 * Assert that a ReplParseException is thrown with a given message.
-	 *
-	 * @param msg
-	 *            The message.
-	 * @param fle
-	 *            The file to load input from.
-	 */
 	public static void assertThrownMessage(String msg, String fle) {
 		assertThrownMessage(false, msg, fle);
 	}
 
-	/**
-	 * Assert that a ReplParseException is thrown with a given message.
-	 *
-	 * @param logMsg
-	 *               Log the exception message.
-	 * @param msg
-	 *               The message.
-	 * @param fle
-	 *               The file to load input from.
-	 */
 	public static void assertThrownMessage(boolean logMsg, String msg, String fle) {
 		try (FileInputStream fis = new FileInputStream(fle);
 				Scanner scn = new Scanner(fis)) {