From 5cd7210cd84afb1e3846fbe0e39baa1e79962e2e Mon Sep 17 00:00:00 2001
From: Ben Culkin <scorpress@gmail.com>
Date: Mon, 13 Apr 2020 18:35:08 -0400
Subject: Add some javadoc

Add some javadoc comments
---
 src/main/java/bjc/rgens/parser/ConfigSet.java           |  6 +++---
 .../bjc/rgens/parser/elements/BlankCaseElement.java     |  8 ++++++++
 .../java/bjc/rgens/parser/elements/CaseElement.java     |  3 +++
 .../bjc/rgens/parser/elements/ChanceCaseElement.java    | 17 +++++++++++++++++
 .../rgens/parser/elements/ExpVariableCaseElement.java   | 10 ++++++++++
 5 files changed, 41 insertions(+), 3 deletions(-)

(limited to 'src')

diff --git a/src/main/java/bjc/rgens/parser/ConfigSet.java b/src/main/java/bjc/rgens/parser/ConfigSet.java
index 0ed8167..c2f0937 100644
--- a/src/main/java/bjc/rgens/parser/ConfigSet.java
+++ b/src/main/java/bjc/rgens/parser/ConfigSet.java
@@ -21,18 +21,18 @@ public class ConfigSet {
 	// methods for them, since at least grammars have some extra stuff that
 	// needs to be done when they are associated/unassociated with a config
 	// set.
-	/*
+	/**
 	 * Represents all of the grammar sets that are mapped into this config
 	 * set.
 	 */
 	public final Map<String, RGrammarSet>     grammars;
 
-	/*
+	/**
 	 * Represents all of the templates that are mapped into this config set.
 	 */
 	public final Map<String, GrammarTemplate> templates;
 
-	/*
+	/**
 	 * Represents all of the sub-configurations that are mapped into this
 	 * config set.
 	 */
diff --git a/src/main/java/bjc/rgens/parser/elements/BlankCaseElement.java b/src/main/java/bjc/rgens/parser/elements/BlankCaseElement.java
index 7229e92..c295864 100755
--- a/src/main/java/bjc/rgens/parser/elements/BlankCaseElement.java
+++ b/src/main/java/bjc/rgens/parser/elements/BlankCaseElement.java
@@ -1,6 +1,14 @@
 package bjc.rgens.parser.elements;
 
+/**
+ * A case element that has no result.
+ * @author Ben Culkin
+ *
+ */
 public class BlankCaseElement extends LiteralCaseElement {
+	/**
+	 * Create a new blank case element.
+	 */
 	public BlankCaseElement() {
 		super("");
 	}
diff --git a/src/main/java/bjc/rgens/parser/elements/CaseElement.java b/src/main/java/bjc/rgens/parser/elements/CaseElement.java
index 6c3bd2e..76b4efe 100755
--- a/src/main/java/bjc/rgens/parser/elements/CaseElement.java
+++ b/src/main/java/bjc/rgens/parser/elements/CaseElement.java
@@ -27,6 +27,9 @@ public abstract class CaseElement {
 		/** An element that represents a variable that stores a string. */
 		VARIABLE(false);
 
+		/**
+		 * Whether or not to add spacing after each element.
+		 */
 		public final boolean spacing;
 
 		private ElementType(boolean spacing) {
diff --git a/src/main/java/bjc/rgens/parser/elements/ChanceCaseElement.java b/src/main/java/bjc/rgens/parser/elements/ChanceCaseElement.java
index 483a103..1edccd3 100644
--- a/src/main/java/bjc/rgens/parser/elements/ChanceCaseElement.java
+++ b/src/main/java/bjc/rgens/parser/elements/ChanceCaseElement.java
@@ -2,11 +2,27 @@ package bjc.rgens.parser.elements;
 
 import bjc.rgens.parser.GenerationState;
 
+/**
+ * A case element that has a '1 in n' chance to generate something.
+ * @author Ben Culkin
+ *
+ */
 public class ChanceCaseElement extends CaseElement {
+	/**
+	 * The case element to generate.
+	 */
 	public final CaseElement elm;
 
+	/**
+	 * The 'rarity' of generating output.
+	 */
 	public int chance;
 
+	/**
+	 * Create a new chance case element.
+	 * @param elm The element to generate.
+	 * @param chance The 'n' in the '1 in n' chance to generate the element.
+	 */
 	public ChanceCaseElement(CaseElement elm, int chance) {
 		super(elm.spacing);
 
@@ -14,6 +30,7 @@ public class ChanceCaseElement extends CaseElement {
 		this.chance = chance;
 	}
 
+	@Override
 	public void generate(GenerationState state) {
 		if(state.rnd.nextInt(chance) == 0) elm.generate(state);
 	}
diff --git a/src/main/java/bjc/rgens/parser/elements/ExpVariableCaseElement.java b/src/main/java/bjc/rgens/parser/elements/ExpVariableCaseElement.java
index 03eebe3..78b3d14 100755
--- a/src/main/java/bjc/rgens/parser/elements/ExpVariableCaseElement.java
+++ b/src/main/java/bjc/rgens/parser/elements/ExpVariableCaseElement.java
@@ -5,7 +5,17 @@ import bjc.rgens.parser.GrammarException;
 import bjc.rgens.parser.RGrammar;
 import bjc.rgens.parser.Rule;
 
+/**
+ * Case element that defines a expanded-rule variable.
+ * @author Ben Culkin
+ *
+ */
 public class ExpVariableCaseElement extends VariableDefCaseElement {
+	/**
+	 * Create a new variable-expanding element.
+	 * @param name The name of the variable.
+	 * @param def The definition of the variable.
+	 */
 	public ExpVariableCaseElement(String name, String def) {
 		super(name, def);
 	}
-- 
cgit v1.2.3