summaryrefslogtreecommitdiff
path: root/dice-lang/src
diff options
context:
space:
mode:
authorbculkin2442 <bjculkin@mix.wvu.edu>2016-11-16 11:32:45 -0500
committerbculkin2442 <bjculkin@mix.wvu.edu>2016-11-16 11:32:45 -0500
commite7a7cf10e2e9e05a6b12fd7c4d8d0ff2146901d9 (patch)
tree394027a77946ecd1f4242767592547b599639811 /dice-lang/src
parent9a842bea599230fcd25c36024984e09c50222082 (diff)
Documentation update
Diffstat (limited to 'dice-lang/src')
-rw-r--r--dice-lang/src/bjc/dicelang/ast/DummyResult.java12
-rw-r--r--dice-lang/src/bjc/dicelang/examples/DiceExpressionPreparer.java11
2 files changed, 21 insertions, 2 deletions
diff --git a/dice-lang/src/bjc/dicelang/ast/DummyResult.java b/dice-lang/src/bjc/dicelang/ast/DummyResult.java
index a84bb7c..dec615d 100644
--- a/dice-lang/src/bjc/dicelang/ast/DummyResult.java
+++ b/dice-lang/src/bjc/dicelang/ast/DummyResult.java
@@ -1,11 +1,23 @@
package bjc.dicelang.ast;
+/**
+ * A dummy result
+ *
+ * @author ben
+ *
+ */
public class DummyResult implements IResult {
/*
* The reason why this result is a dummy
*/
private String dummyData;
+ /**
+ * Create a new dummy result with a reason
+ *
+ * @param data
+ * The reason why the result is a dummy
+ */
public DummyResult(String data) {
dummyData = data;
}
diff --git a/dice-lang/src/bjc/dicelang/examples/DiceExpressionPreparer.java b/dice-lang/src/bjc/dicelang/examples/DiceExpressionPreparer.java
index 5488b5d..14dad7c 100644
--- a/dice-lang/src/bjc/dicelang/examples/DiceExpressionPreparer.java
+++ b/dice-lang/src/bjc/dicelang/examples/DiceExpressionPreparer.java
@@ -50,9 +50,16 @@ public class DiceExpressionPreparer {
// to a variable expression
}
- // Prepare a command, turning raw tokens into input for the tree builder
+ /**
+ * Prepare a command, turning raw tokens into input for the tree
+ * builder
+ *
+ * @param currentLine
+ * The command to prepare
+ * @return A stream of tokens representing the command
+ */
public static IList<String> prepareCommand(String currentLine) {
- // Split the command into tokens
+ // Split the command into tokens
IList<String> tokens = FunctionalStringTokenizer
.fromString(currentLine).toList();