forgetest1
/
antlr
forked from jasder/antlr
1
0
Fork 0
Code Issues Pull Requests 1 Releases Wiki Activity

Fix javadoc issues

This commit is contained in:
Sam Harwell 2013-01-02 06:55:38 -06:00
parent 274d566be6
commit 8c92df27c6
4 changed files with 16 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
runtime/Java/src/org/antlr/v4/runtime/dfa/DFAState.java
View File

@ -160,16 +160,18 @@ public class DFAState {
return h;
}
/** Two DFAStates are equal if their ATN configuration sets are the
* same. This method is used to see if a DFA state already exists.
/**
* Two {@link DFAState} instances are equal if their ATN configuration sets
* are the same. This method is used to see if a state already exists.
* <p/>
* Because the number of alternatives and number of ATN configurations are
* finite, there is a finite number of DFA states that can be processed.
* This is necessary to show that the algorithm terminates.
* Because the number of alternatives and number of ATN configurations are
* finite, there is a finite number of DFA states that can be processed.
* This is necessary to show that the algorithm terminates.
* <p/>
* Cannot test the DFA state numbers here because in {@link DFA#addState} we need
* to know if any other state exists that has this exact set of ATN
* configurations. The {@link DFAState#stateNumber} is irrelevant.
* Cannot test the DFA state numbers here because in
* {@link ParserATNSimulator#addDFAState} we need to know if any other state
* exists that has this exact set of ATN configurations. The
* {@link #stateNumber} is irrelevant.
*/
@Override
public boolean equals(Object o) {

6
runtime/Java/src/org/antlr/v4/runtime/misc/Array2DHashSet.java
View File

@ -448,8 +448,8 @@ public class Array2DHashSet<T> implements Set<T> {
}
/**
* Return {@code o} as an instance of the element type {@link T}. If
* {@code o} is non-null but known to not be an instance of {@link T}, this
* Return {@code o} as an instance of the element type {@code T}. If
* {@code o} is non-null but known to not be an instance of {@code T}, this
* method returns {@code null}. The base implementation does not perform any
* type checks; override this method to provide strong type checks for the
* {@link #contains} and {@link #remove} methods to ensure the arguments to
@ -457,7 +457,7 @@ public class Array2DHashSet<T> implements Set<T> {
* types.
*
* @param o the object to try and cast to the element type of the set
* @return {@code o} if it could be an instance of {@link T}, otherwise
* @return {@code o} if it could be an instance of {@code T}, otherwise
* {@code null}.
*/
@SuppressWarnings("unchecked")

2
runtime/Java/src/org/antlr/v4/runtime/tree/ParseTree.java
View File

@ -31,6 +31,8 @@
package org.antlr.v4.runtime.tree;
import org.antlr.v4.runtime.Parser;
import org.antlr.v4.runtime.RuleContext;
import org.antlr.v4.runtime.Token;
/** An interface to access the tree of {@link RuleContext} objects created
* during a parse that makes the data structure look like a simple parse tree.

1
runtime/Java/src/org/antlr/v4/runtime/tree/SyntaxTree.java
View File

@ -30,6 +30,7 @@
package org.antlr.v4.runtime.tree;
import org.antlr.v4.runtime.TokenStream;
import org.antlr.v4.runtime.misc.Interval;
import org.antlr.v4.runtime.misc.NotNull;