Merge pull request #631 from sharwell/javadoc-issues

Fix documentation errors reported during the build
This commit is contained in:
Sam Harwell 2014-06-17 06:33:09 -05:00
commit 6701202f66
5 changed files with 9 additions and 7 deletions

View File

@ -88,7 +88,7 @@ public interface ANTLRErrorListener {
* *
* <p>Each full-context prediction which does not result in a syntax error * <p>Each full-context prediction which does not result in a syntax error
* will call either {@link #reportContextSensitivity} or * will call either {@link #reportContextSensitivity} or
* {@link reportAmbiguity}.</p> * {@link #reportAmbiguity}.</p>
* *
* <p>When {@code ambigAlts} is not null, it contains the set of potentially * <p>When {@code ambigAlts} is not null, it contains the set of potentially
* viable alternatives identified by the prediction algorithm. When * viable alternatives identified by the prediction algorithm. When
@ -166,7 +166,7 @@ public interface ANTLRErrorListener {
* *
* <p>Each full-context prediction which does not result in a syntax error * <p>Each full-context prediction which does not result in a syntax error
* will call either {@link #reportContextSensitivity} or * will call either {@link #reportContextSensitivity} or
* {@link reportAmbiguity}.</p> * {@link #reportAmbiguity}.</p>
* *
* <p>For prediction implementations that only evaluate full-context * <p>For prediction implementations that only evaluate full-context
* predictions when an SLL conflict is found (including the default * predictions when an SLL conflict is found (including the default

View File

@ -114,7 +114,7 @@ public class RuntimeMetaData {
public interface Listener { public interface Listener {
/** /**
* Report a version mismatch which was detected by * Report a version mismatch which was detected by
* {@link #checkDetails}. * {@link #checkVersion}.
* *
* <p> * <p>
* Implementations of this method may, but are not required to, throw * Implementations of this method may, but are not required to, throw
@ -147,7 +147,7 @@ public class RuntimeMetaData {
*/ */
public static class DefaultListener implements Listener { public static class DefaultListener implements Listener {
/** /**
* A default instance of {@link ConsoleListener} which is automatically * A default instance of {@link DefaultListener} which is automatically
* registered to receive version mismatch events. * registered to receive version mismatch events.
*/ */
public static final DefaultListener INSTANCE = new DefaultListener(); public static final DefaultListener INSTANCE = new DefaultListener();

View File

@ -91,7 +91,7 @@ public class DecisionInfo {
public long SLL_MaxLook; public long SLL_MaxLook;
/** /**
* Gets the {@link LookaheadEventInfo} associated with the event where the * Gets the {@link LookaheadEventInfo} associated with the event where the
* {@link #sllMaxLook} value was set. * {@link #SLL_MaxLook} value was set.
*/ */
public LookaheadEventInfo SLL_MaxLookEvent; public LookaheadEventInfo SLL_MaxLookEvent;

View File

@ -30,6 +30,8 @@
package org.antlr.v4.runtime.misc; package org.antlr.v4.runtime.misc;
import org.antlr.v4.runtime.Token;
import java.util.List; import java.util.List;
/** /**
@ -121,7 +123,7 @@ public interface IntSet {
* <li>{@code x.complement(y)}</li> * <li>{@code x.complement(y)}</li>
* </ul> * </ul>
* *
* @param elements The set to compare with the current set. A {@code null} * @param a The set to compare with the current set. A {@code null}
* argument is treated as though it were an empty set. * argument is treated as though it were an empty set.
* @return A new {@link IntSet} instance containing the elements present in * @return A new {@link IntSet} instance containing the elements present in
* {@code elements} but not present in the current set. The value * {@code elements} but not present in the current set. The value

View File

@ -208,7 +208,7 @@ public class IntervalSet implements IntSet {
return this.complement(IntervalSet.of(minElement,maxElement)); return this.complement(IntervalSet.of(minElement,maxElement));
} }
/** {@inheritDoc */ /** {@inheritDoc} */
@Override @Override
public IntervalSet complement(IntSet vocabulary) { public IntervalSet complement(IntSet vocabulary) {
if ( vocabulary==null || vocabulary.isNil() ) { if ( vocabulary==null || vocabulary.isNil() ) {