From 9139064c95f6c9c4f7ba1d0aea21e2f5233ad188 Mon Sep 17 00:00:00 2001
From: bculkin2442 <bjculkin@mix.wvu.edu>
Date: Mon, 6 Mar 2017 14:15:03 -0500
Subject: Formatting/Documentation

---
 dice-lang/src/bjc/dicelang/dice/DieExpression.java | 30 +++++++++++++++++++++-
 1 file changed, 29 insertions(+), 1 deletion(-)

(limited to 'dice-lang/src/bjc/dicelang/dice/DieExpression.java')

diff --git a/dice-lang/src/bjc/dicelang/dice/DieExpression.java b/dice-lang/src/bjc/dicelang/dice/DieExpression.java
index 3bf121b..81d0b7d 100644
--- a/dice-lang/src/bjc/dicelang/dice/DieExpression.java
+++ b/dice-lang/src/bjc/dicelang/dice/DieExpression.java
@@ -2,29 +2,57 @@ package bjc.dicelang.dice;
 
 import java.util.Arrays;
 
+/**
+ * Represents either a die or a die list
+ * 
+ * @author Ben Culkin
+ */
 public class DieExpression {
+	/**
+	 * Is this expression a list?
+	 */
 	public final boolean isList;
 
+	/**
+	 * The scalar value in this expression, if there is one.
+	 */
 	public Die     scalar;
+	/**
+	 * The list value in this expression, if there is one.
+	 */
 	public DieList list;
 
+	/**
+	 * Create a scalar die expression.
+	 *
+	 * @param scal The scalar value of this expression.
+	 */
 	public DieExpression(Die scal) {
 		isList = false;
 		scalar = scal;
 	}
 
+	/**
+	 * Create a list die expression.
+	 *
+	 * @param lst The list value of this expression.
+	 */
 	public DieExpression(DieList lst) {
 		isList = true;
 		list   = lst;
 	}
 
+	@Override
 	public String toString() {
 		if(isList) return list.toString();
 		else       return scalar.toString();
 	}
 
+	/**
+	 * Get the value of this expression as a string.
+	 */
 	public String value() {
 		if(isList) return Arrays.toString(list.roll());
 		else       return Long.toString(scalar.roll());
 	}
-}
\ No newline at end of file
+}
-- 
cgit v1.2.3