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/CompoundDie.java | 24 +++++++++++++++++++++++-
 1 file changed, 23 insertions(+), 1 deletion(-)

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

diff --git a/dice-lang/src/bjc/dicelang/dice/CompoundDie.java b/dice-lang/src/bjc/dicelang/dice/CompoundDie.java
index 16aec76..a20095a 100644
--- a/dice-lang/src/bjc/dicelang/dice/CompoundDie.java
+++ b/dice-lang/src/bjc/dicelang/dice/CompoundDie.java
@@ -1,31 +1,53 @@
 package bjc.dicelang.dice;
 
+/**
+ * A die whose rolls result from concatenating two other rolls together.
+ *
+ * @author Ben Culkin
+ */
 public class CompoundDie implements Die {
+	/*
+	 * The dice that form this die
+	 */
 	private Die left;
 	private Die right;
 
+	/**
+	 * Create a new compound die.
+	 *
+	 * @param lft The left die
+	 * @param rght The right die
+	 */
 	public CompoundDie(Die lft, Die rght) {
 		left = lft;
 		right = rght;
 	}
 
+	@Override
 	public boolean canOptimize() {
 		return left.canOptimize() && right.canOptimize();
 	}
 
+	@Override
 	public long optimize() {
 		return Long.parseLong(left.optimize() + "" + right.optimize());
 	}
 
+	@Override
 	public long roll() {
 		return Long.parseLong(left.roll() + "" + right.roll());
 	}
 
+	@Override
 	public long rollSingle() {
+		/*
+		 * We're only one die, we can't be split
+		 */
 		return roll();
 	}
 
+	@Override
 	public String toString() {
 		return left.toString() + "c" + right.toString();
 	}
-}
\ No newline at end of file
+}
-- 
cgit v1.2.3