summaryrefslogtreecommitdiff
path: root/base
diff options
context:
space:
mode:
authorBen Culkin <scorpress@gmail.com>2020-04-13 18:30:53 -0400
committerBen Culkin <scorpress@gmail.com>2020-04-13 18:30:53 -0400
commit2ac2e31a56ae59ee582e43a90c3495f86dd9ee7a (patch)
tree9e5c3c839d0515858d862a33849c7ae329e38a28 /base
parent3819027f642df549622c478331391ad3a25a9c4f (diff)
Add some javadoc.
Add some javadoc comments
Diffstat (limited to 'base')
-rw-r--r--base/src/main/java/bjc/utils/exceptions/InvalidToken.java9
-rw-r--r--base/src/main/java/bjc/utils/math/DualExprParser.java14
-rw-r--r--base/src/test/java/bjc/utils/test/math/DualExprParserTest.java1
3 files changed, 24 insertions, 0 deletions
diff --git a/base/src/main/java/bjc/utils/exceptions/InvalidToken.java b/base/src/main/java/bjc/utils/exceptions/InvalidToken.java
index b09af78..be8fcd9 100644
--- a/base/src/main/java/bjc/utils/exceptions/InvalidToken.java
+++ b/base/src/main/java/bjc/utils/exceptions/InvalidToken.java
@@ -1,8 +1,17 @@
package bjc.utils.exceptions;
+/**
+ * Exception thrown when an invalid token is found.
+ * @author Ben Culkin
+ *
+ */
public class InvalidToken extends RuntimeException {
private static final long serialVersionUID = -5077165766341244689L;
+ /**
+ * Create an invalid token exception.
+ * @param tok The token that was invalid.
+ */
public InvalidToken(String tok) {
super(String.format("Did not recognize token '%s' as a valid token", tok));
}
diff --git a/base/src/main/java/bjc/utils/math/DualExprParser.java b/base/src/main/java/bjc/utils/math/DualExprParser.java
index 07d0fe8..d90024f 100644
--- a/base/src/main/java/bjc/utils/math/DualExprParser.java
+++ b/base/src/main/java/bjc/utils/math/DualExprParser.java
@@ -21,10 +21,24 @@ import bjc.utils.math.DualExpr.ExprType;
*
*/
public class DualExprParser {
+ /**
+ * Result class from parsing exprs.
+ * @author Ben Culkin
+ *
+ */
public static class Result {
+ /**
+ * The resulting expression.
+ */
public DualExpr expr;
+ /**
+ * Any variables we found in the expression.
+ */
public Map<String, DualExpr> varMap;
+ /**
+ * Create a new result.
+ */
public Result() {
this.varMap = new HashMap<>();
}
diff --git a/base/src/test/java/bjc/utils/test/math/DualExprParserTest.java b/base/src/test/java/bjc/utils/test/math/DualExprParserTest.java
index 1960b53..1f822b6 100644
--- a/base/src/test/java/bjc/utils/test/math/DualExprParserTest.java
+++ b/base/src/test/java/bjc/utils/test/math/DualExprParserTest.java
@@ -14,6 +14,7 @@ import bjc.utils.math.DualExpr;
import bjc.utils.math.DualExprParser;
import bjc.utils.math.DualExprParser.Result;
+@SuppressWarnings("javadoc")
public class DualExprParserTest {
@Test