GH-392 Add missing docs in parser design classes

panda-lang · Nov 1, 2019 · d47ffe0 · d47ffe0
1 parent 51d17ea
commit d47ffe0
Show file tree

Hide file tree

Showing 6 changed files with 28 additions and 23 deletions.
diff --git a/...rk/src/main/java/org/panda_lang/framework/design/interpreter/parser/ContextComponent.java b/...rk/src/main/java/org/panda_lang/framework/design/interpreter/parser/ContextComponent.java
@@ -21,6 +21,11 @@
 import java.util.HashMap;
 import java.util.Map;
 
+/**
+ * Represents components used in the {@link org.panda_lang.framework.design.interpreter.parser.Context}
+ *
+ * @param <T> type of stored value
+ */
 public class ContextComponent<T> extends Component<T> {
 
     private static final Map<String, ContextComponent<?>> COMPONENTS = new HashMap<>();

diff --git a/...ework/src/main/java/org/panda_lang/framework/design/interpreter/parser/ContextParser.java b/...ework/src/main/java/org/panda_lang/framework/design/interpreter/parser/ContextParser.java
@@ -16,6 +16,11 @@
 
 package org.panda_lang.framework.design.interpreter.parser;
 
+/**
+ * Represents parsers supported by pipelines
+ *
+ * @param <T> type of result
+ */
 public interface ContextParser<T> extends Parser {
 
     /**

diff --git a/...amework/src/main/java/org/panda_lang/framework/design/interpreter/parser/ParserDebug.java b/...amework/src/main/java/org/panda_lang/framework/design/interpreter/parser/ParserDebug.java
diff --git a/...ework/src/main/java/org/panda_lang/framework/design/interpreter/parser/ParserFailure.java b/...ework/src/main/java/org/panda_lang/framework/design/interpreter/parser/ParserFailure.java
@@ -18,8 +18,16 @@
 
 import org.panda_lang.framework.design.Failure;
 
+/**
+ * Represents errors associated with parsers
+ */
 public interface ParserFailure extends Failure {
 
+    /**
+     * Get associated context
+     *
+     * @return the context
+     */
     Context getContext();
 
 }
diff --git a/...rc/main/java/org/panda_lang/framework/design/interpreter/parser/ParserRepresentation.java b/...rc/main/java/org/panda_lang/framework/design/interpreter/parser/ParserRepresentation.java
@@ -18,6 +18,11 @@
 
 import org.panda_lang.framework.design.interpreter.parser.pipeline.Handler;
 
+/**
+ * Parser container
+ *
+ * @param <P> type of stored parser
+ */
 public interface ParserRepresentation<P> {
 
     /**

diff --git a/...mework/src/main/java/org/panda_lang/framework/design/interpreter/parser/SourceParser.java b/...mework/src/main/java/org/panda_lang/framework/design/interpreter/parser/SourceParser.java
@@ -18,6 +18,11 @@
 
 import org.panda_lang.framework.design.interpreter.token.Snippet;
 
+/**
+ * Similar to {@link org.panda_lang.framework.design.interpreter.parser.ContextParser}, but with custom source
+ *
+ * @param <T> type of result
+ */
 public interface SourceParser<T> extends Parser {
 
     /**