Updated javadoc

This commit is contained in:
Sam Harwell 2012-11-26 20:19:09 -06:00
parent 6369097630
commit 769e0a418e
3 changed files with 7 additions and 7 deletions

View File

@ -31,6 +31,7 @@ package org.antlr.v4.runtime.misc;
import java.util.Arrays; import java.util.Arrays;
import java.util.Collection; import java.util.Collection;
import java.util.List;
/** /**
* *
@ -191,14 +192,14 @@ public class IntegerList {
/** /**
* Compares the specified object with this list for equality. Returns * Compares the specified object with this list for equality. Returns
* {@code true} if and only if the specified object is also an {@code IntegerList}, * {@code true} if and only if the specified object is also an {@link IntegerList},
* both lists have the same size, and all corresponding pairs of elements in * both lists have the same size, and all corresponding pairs of elements in
* the two lists are equal. In other words, two lists are defined to be * the two lists are equal. In other words, two lists are defined to be
* equal if they contain the same elements in the same order. * equal if they contain the same elements in the same order.
* <p> * <p>
* This implementation first checks if the specified object is this * This implementation first checks if the specified object is this
* list. If so, it returns {@code true}; if not, it checks if the * list. If so, it returns {@code true}; if not, it checks if the
* specified object is an {@code IntegerList}. If not, it returns {@code false}; * specified object is an {@link IntegerList}. If not, it returns {@code false};
* if so, it checks the size of both lists. If the lists are not the same size, * if so, it checks the size of both lists. If the lists are not the same size,
* it returns {@code false}; otherwise it iterates over both lists, comparing * it returns {@code false}; otherwise it iterates over both lists, comparing
* corresponding pairs of elements. If any comparison returns {@code false}, * corresponding pairs of elements. If any comparison returns {@code false},
@ -233,8 +234,8 @@ public class IntegerList {
/** /**
* Returns the hash code value for this list. * Returns the hash code value for this list.
* * <p/>
* <p>This implementation uses exactly the code that is used to define the * This implementation uses exactly the code that is used to define the
* list hash function in the documentation for the {@link List#hashCode} * list hash function in the documentation for the {@link List#hashCode}
* method. * method.
* *

View File

@ -110,7 +110,7 @@ public class ParseTreeVisitor<T> {
* *
* @param aggregate The previous aggregate value. In the default * @param aggregate The previous aggregate value. In the default
* implementation, the aggregate value is initialized to * implementation, the aggregate value is initialized to
* {@link #defaultValue}, which is passed as the {@code aggregate} argument * {@link #defaultResult}, which is passed as the {@code aggregate} argument
* to this method after the first child node is visited. * to this method after the first child node is visited.
* @param nextResult The result of the immediately preceeding call to visit * @param nextResult The result of the immediately preceeding call to visit
* a child node. * a child node.
@ -126,7 +126,7 @@ public class ParseTreeVisitor<T> {
* {@link #visitChildren}. This method is first called before the first * {@link #visitChildren}. This method is first called before the first
* child is visited; at that point {@code currentResult} will be the initial * child is visited; at that point {@code currentResult} will be the initial
* value (in the default implementation, the initial value is returned by a * value (in the default implementation, the initial value is returned by a
* call to {@link #defaultValue}. * call to {@link #defaultResult}.
* <p/> * <p/>
* The default implementation always returns {@code true}, indicating that * The default implementation always returns {@code true}, indicating that
* {@code visitChildren} should only return after all children are visited. * {@code visitChildren} should only return after all children are visited.

View File

@ -724,7 +724,6 @@ public class Tool {
* given relative to the input directory. * given relative to the input directory.
* *
* @param fileNameWithPath path to input source * @param fileNameWithPath path to input source
* @return
*/ */
public File getOutputDirectory(String fileNameWithPath) { public File getOutputDirectory(String fileNameWithPath) {
File outputDir; File outputDir;