From e9e0ca7bfe722375e7ccb25d2bafbe395b6c6a59 Mon Sep 17 00:00:00 2001
From: Ben Culkin <scorpress@gmail.com>
Date: Tue, 6 Oct 2020 19:16:26 -0400
Subject: Info cleanup

---
 .../java/bjc/rgens/parser/RGrammarLogging.java     | 55 +++++++++++++++++++++-
 1 file changed, 54 insertions(+), 1 deletion(-)

(limited to 'src/main/java/bjc/rgens/parser/RGrammarLogging.java')

diff --git a/src/main/java/bjc/rgens/parser/RGrammarLogging.java b/src/main/java/bjc/rgens/parser/RGrammarLogging.java
index 4dba117..dbc36b4 100644
--- a/src/main/java/bjc/rgens/parser/RGrammarLogging.java
+++ b/src/main/java/bjc/rgens/parser/RGrammarLogging.java
@@ -7,14 +7,31 @@ package bjc.rgens.parser;
  * @author Ben Culkin
  */
 public final class RGrammarLogging {
+	/**
+	 * Log a message.
+	 * @param msg The message to log.
+	 * @param vars The variable for the message.
+	 */
 	public static void log(String msg, Object... vars) {
 		System.err.printf(msg, vars);
 	}
-
+	
+	/**
+	 * Log a message, including a newline.
+	 * @param msg The message to log.
+	 * @param vars The variable for the message.
+	 */
 	public static void logline(String msg, Object... vars) {
 		log(msg + "\n", vars);
 	}
 
+	/**
+	 * Log an error, including an exception stack trace.
+	 * 
+	 * @param ex The exception which caused this error.
+	 * @param msg The message to log.
+	 * @param vars The variables for the message.
+	 */
 	public static void error(Exception ex, String msg, Object... vars) {
 		logline("ERROR: " + msg, vars);
 
@@ -24,26 +41,62 @@ public final class RGrammarLogging {
 		logline("");
 	}
 
+	/**
+	 * Log a performance message.
+	 * 
+	 * @param msg The message to log.
+	 * @param vars The variable for the message.
+	 */
 	public static void perf(String msg, Object... vars) {
 		logline("\tPERF: " + msg, vars);
 	}
 
+	/**
+	 * Log a info message.
+	 * 
+	 * @param msg The message to log.
+	 * @param vars The variable for the message.
+	 */
 	public static void info(String msg, Object... vars) {
 		logline("INFO: " + msg, vars);
 	}
 
+	/**
+	 * Log a trace message.
+	 * 
+	 * @param msg The message to log.
+	 * @param vars The variable for the message.
+	 */
 	public static void trace(String msg, Object... vars) {
 		logline("\t\tTRACE: " + msg, vars);
 	}
 
+	/**
+	 * Log a warn message.
+	 * 
+	 * @param msg The message to log.
+	 * @param vars The variable for the message.
+	 */
 	public static void warn(String msg, Object... vars) {
 		logline("WARN: " + msg, vars);
 	}
 
+	/**
+	 * Log a debug message.
+	 * 
+	 * @param msg The message to log.
+	 * @param vars The variable for the message.
+	 */
 	public static void debug(String msg, Object... vars) {
 		logline("\tDEBUG: " + msg, vars);
 	}
 
+	/**
+	 * Log a fine message.
+	 * 
+	 * @param msg The message to log.
+	 * @param vars The variable for the message.
+	 */
 	public static void fine(String msg, Object... vars) {
 		logline("\t\tFINE: " + msg, vars);
 	}
-- 
cgit v1.2.3