From 40858cee415643769ee5f6216b0cd4335996ff2f Mon Sep 17 00:00:00 2001
From: bjculkin <bjculkin@mix.wvu.edu>
Date: Tue, 11 Apr 2017 17:51:13 -0400
Subject: General cleanup and fixes

---
 .../src/bjc/dicelang/scl/StreamControlEngine.java  | 11 +++++++--
 dice-lang/src/bjc/dicelang/scl/StreamEngine.java   | 26 +++++++++++++++++++++-
 2 files changed, 34 insertions(+), 3 deletions(-)

(limited to 'dice-lang/src/bjc/dicelang/scl')

diff --git a/dice-lang/src/bjc/dicelang/scl/StreamControlEngine.java b/dice-lang/src/bjc/dicelang/scl/StreamControlEngine.java
index c0a8d86..7efcaf7 100644
--- a/dice-lang/src/bjc/dicelang/scl/StreamControlEngine.java
+++ b/dice-lang/src/bjc/dicelang/scl/StreamControlEngine.java
@@ -179,8 +179,15 @@ public class StreamControlEngine {
 
 	private Stack<Token> curStack;
 
+	@SuppressWarnings("unused")
 	private Map<String, Token> words;
 
+	/**
+	 * Create a new stream control engine.
+	 * 
+	 * @param eng
+	 *                The engine to control.
+	 */
 	public StreamControlEngine(StreamEngine eng) {
 		this.eng = eng;
 
@@ -192,9 +199,9 @@ public class StreamControlEngine {
 	 * Run a SCL program.
 	 *
 	 * @param tokens
-	 *                The program to run
+	 *                The program to run.
 	 *
-	 * @return Whether the program executed succesfully
+	 * @return Whether the program executed successfully.
 	 */
 	public boolean runProgram(String[] tokens) {
 		for(int i = 0; i < tokens.length; i++) {
diff --git a/dice-lang/src/bjc/dicelang/scl/StreamEngine.java b/dice-lang/src/bjc/dicelang/scl/StreamEngine.java
index f8d6e09..26b99c4 100644
--- a/dice-lang/src/bjc/dicelang/scl/StreamEngine.java
+++ b/dice-lang/src/bjc/dicelang/scl/StreamEngine.java
@@ -71,10 +71,11 @@ public class StreamEngine {
 	}
 
 	/**
-	 * Process a possibly interleaved set of streams from toks into dest.
+	 * Process a possibly interleaved set of streams.
 	 *
 	 * @param toks
 	 *                The raw token to read streams from.
+	 * 
 	 * @param dest
 	 *                The list to write the final stream to.
 	 *
@@ -120,10 +121,18 @@ public class StreamEngine {
 		return true;
 	}
 
+	/**
+	 * Create a new stream.
+	 */
 	public void newStream() {
 		streams.insertAfter(new FunctionalList<>());
 	}
 
+	/**
+	 * Move to a stream to the right.
+	 * 
+	 * @return Whether or not the move was successful.
+	 */
 	public boolean rightStream() {
 		if(!streams.right()) {
 			Errors.inst.printError(EK_STRM_NONEX);
@@ -134,6 +143,11 @@ public class StreamEngine {
 		return true;
 	}
 
+	/**
+	 * Move to a stream to the left.
+	 * 
+	 * @return Whether or not the move was successful.
+	 */
 	public boolean leftStream() {
 		if(!streams.left()) {
 			Errors.inst.printError(EK_STRM_NONEX);
@@ -144,6 +158,11 @@ public class StreamEngine {
 		return true;
 	}
 
+	/**
+	 * Delete the current stream.
+	 * 
+	 * @return Whether or not the delete succeeded.
+	 */
 	public boolean deleteStream() {
 		if(streams.size() == 1) {
 			Errors.inst.printError(EK_STRM_LAST);
@@ -156,6 +175,11 @@ public class StreamEngine {
 		return true;
 	}
 
+	/**
+	 * Merge the current stream into the previous stream.
+	 * 
+	 * @return Whether or not the merge succeded.
+	 */
 	public boolean mergeStream() {
 		if(streams.size() == 1) {
 			Errors.inst.printError(EK_STRM_LAST);
-- 
cgit v1.2.3