Improve Javadoc tag formatting

6 files changed, 27 insertions, 27 deletions

diff --git a/annotation-file-utilities/src/annotator/find/ASTPathCriterion.java b/annotation-file-utilities/src/annotator/find/ASTPathCriterion.java
index 7a93484..793f9fa 100644
--- a/annotation-file-utilities/src/annotator/find/ASTPathCriterion.java
+++ b/annotation-file-utilities/src/annotator/find/ASTPathCriterion.java
@@ -80,7 +80,7 @@ public class ASTPathCriterion implements Criterion {
      * arguments have been previously validated.
      *
      * @param astPath
-     *            The AST path to match
+     *            the AST path to match
      */
     public ASTPathCriterion(ASTPath astPath) {
         this.astPath = astPath;
@@ -981,9 +981,9 @@ loop:       while (typeTree != null && i < astPath.size()) {
      * BinaryOperator.
      *
      * @param kind1
-     *            The first kind to match
+     *            the first kind to match
      * @param kind2
-     *            The second kind to match
+     *            the second kind to match
      * @return {@code true} if the kinds match as described above, {@code false}
      *         otherwise.
      */
@@ -1006,7 +1006,7 @@ loop:       while (typeTree != null && i < astPath.size()) {
      * Determines if the given kind is a binary operator.
      *
      * @param kind
-     *            The kind to test
+     *            the kind to test
      * @return true if the given kind is a binary operator
      */
     public boolean isBinaryOperator(Tree.Kind kind) {
@@ -1097,7 +1097,7 @@ loop:       while (typeTree != null && i < astPath.size()) {
      * Determines if the given kind is a wildcard.
      *
      * @param kind
-     *            The kind to test
+     *            the kind to test
      * @return true if the given kind is a wildcard
      */
     private boolean isWildcard(Tree.Kind kind) {
diff --git a/annotation-file-utilities/src/annotator/find/GenericArrayLocationCriterion.java b/annotation-file-utilities/src/annotator/find/GenericArrayLocationCriterion.java
index 7f7c956..79920a7 100644
--- a/annotation-file-utilities/src/annotator/find/GenericArrayLocationCriterion.java
+++ b/annotation-file-utilities/src/annotator/find/GenericArrayLocationCriterion.java
@@ -504,7 +504,7 @@ public class GenericArrayLocationCriterion implements Criterion {
   /**
    * Gets the type path location of this criterion.
    *
-   * @return an unmodifiable list of {@link TypePathEntry}s.
+   * @return an unmodifiable list of {@link TypePathEntry}s
    */
   public List<TypePathEntry> getLocation() {
     return Collections.unmodifiableList(location);
diff --git a/annotation-file-utilities/src/annotator/find/Insertion.java b/annotation-file-utilities/src/annotator/find/Insertion.java
index 6e0ba34..12ba329 100644
--- a/annotation-file-utilities/src/annotator/find/Insertion.java
+++ b/annotation-file-utilities/src/annotator/find/Insertion.java
@@ -378,7 +378,7 @@ public abstract class Insertion {
      * type, based on the insertion's type path.
      *
      * @param innerTypeInsertions
-     *          The insertions to add to the type. These must be inner type
+     *          the insertions to add to the type. These must be inner type
      *          insertions, meaning each of the insertions' {@link Criteria}
      *          must contain a {@link GenericArrayLocationCriterion} and
      *          {@link GenericArrayLocationCriterion#getLocation()} must return a
diff --git a/annotation-file-utilities/src/annotator/specification/IndexFileSpecification.java b/annotation-file-utilities/src/annotator/specification/IndexFileSpecification.java
index b7c6340..b64e255 100644
--- a/annotation-file-utilities/src/annotator/specification/IndexFileSpecification.java
+++ b/annotation-file-utilities/src/annotator/specification/IndexFileSpecification.java
@@ -295,7 +295,7 @@ public class IndexFileSpecification implements Specification {
    * Fill in this.insertions with insertion pairs.
    * @param clist the criteria specifying the location of the insertions
    * @param element holds the annotations to be inserted
-   * @return a list of the {@link AnnotationInsertion}s that are created.
+   * @return a list of the {@link AnnotationInsertion}s that are created
    */
   private List<Insertion> parseElement(CriterionList clist, AElement element) {
     return parseElement(clist, element, new ArrayList<Insertion>(), false);
@@ -307,7 +307,7 @@ public class IndexFileSpecification implements Specification {
    * @param element holds the annotations to be inserted
    * @param isCastInsertion {@code true} if this for a cast insertion, {@code false}
    *          otherwise.
-   * @return a list of the {@link AnnotationInsertion}s that are created.
+   * @return a list of the {@link AnnotationInsertion}s that are created
    */
   private List<Insertion> parseElement(CriterionList clist, AElement element,
       boolean isCastInsertion) {
@@ -320,7 +320,7 @@ public class IndexFileSpecification implements Specification {
    * @param element holds the annotations to be inserted
    * @param add {@code true} if the create {@link AnnotationInsertion}s should
    *         be added to {@link #insertions}, {@code false} otherwise.
-   * @return a list of the {@link AnnotationInsertion}s that are created.
+   * @return a list of the {@link AnnotationInsertion}s that are created
    */
   private List<Insertion> parseElement(CriterionList clist, AElement element,
       List<Insertion> innerTypeInsertions) {
@@ -336,7 +336,7 @@ public class IndexFileSpecification implements Specification {
    *         See {@link ReceiverInsertion} for more details.
    * @param isCastInsertion {@code true} if this for a cast insertion, {@code false}
    *          otherwise.
-   * @return a list of the {@link AnnotationInsertion}s that are created.
+   * @return a list of the {@link AnnotationInsertion}s that are created
    */
   private List<Insertion> parseElement(CriterionList clist, AElement element,
       List<Insertion> innerTypeInsertions, boolean isCastInsertion) {
@@ -518,7 +518,7 @@ public class IndexFileSpecification implements Specification {
    *         with annotations only on the compound types.
    * @param innerTypeInsertions the annotations on the inner types
    * @param criteria the criteria for the location of this insertion
-   * @return the {@link CastInsertion} and {@link CloseParenthesisInsertion}.
+   * @return the {@link CastInsertion} and {@link CloseParenthesisInsertion}
    */
   private Pair<CastInsertion, CloseParenthesisInsertion> createCastInsertion(
       Type type, String annotationString, List<Insertion> innerTypeInsertions,
diff --git a/scene-lib/src/annotations/io/ASTPath.java b/scene-lib/src/annotations/io/ASTPath.java
index 9d0e328..35677a9 100644
--- a/scene-lib/src/annotations/io/ASTPath.java
+++ b/scene-lib/src/annotations/io/ASTPath.java
@@ -721,7 +721,7 @@ implements Comparable<ASTPath>, Iterable<ASTPath.ASTEntry> {
      *
      * @param kind the kind of this AST entry
      * @param legalChildSelectors a list of the legal child selectors for this AST entry
-     * @return a new {@link ASTEntry}.
+     * @return a new {@link ASTEntry}
      * @throws ParseException if an illegal argument is found
      */
     private ASTEntry newASTEntry(Tree.Kind kind, String[] legalChildSelectors)
@@ -744,7 +744,7 @@ implements Comparable<ASTPath>, Iterable<ASTPath.ASTEntry> {
      * @param legalChildSelectors a list of the legal child selectors for this AST entry
      * @param argumentChildSelectors a list of the child selectors that also require an argument.
      *                               Entries here should also be in the legalChildSelectors list.
-     * @return a new {@link ASTEntry}.
+     * @return a new {@link ASTEntry}
      * @throws ParseException if an illegal argument is found
      */
     private ASTEntry newASTEntry(Tree.Kind kind, String[] legalChildSelectors,
@@ -1340,9 +1340,9 @@ implements Comparable<ASTPath>, Iterable<ASTPath.ASTEntry> {
      * BinaryOperator.
      *
      * @param kind1
-     *            The first kind to match
+     *            the first kind to match
      * @param kind2
-     *            The second kind to match
+     *            the second kind to match
      * @return {@code true} if the kinds match as described above, {@code false}
      *         otherwise.
      */
@@ -1358,7 +1358,7 @@ implements Comparable<ASTPath>, Iterable<ASTPath.ASTEntry> {
      * Determines if the given kind is a compound assignment.
      *
      * @param kind
-     *            The kind to test
+     *            the kind to test
      * @return true if the given kind is a compound assignment
      */
     private static boolean isCompoundAssignment(Tree.Kind kind) {
@@ -1379,7 +1379,7 @@ implements Comparable<ASTPath>, Iterable<ASTPath.ASTEntry> {
      * Determines if the given kind is a unary operator.
      *
      * @param kind
-     *            The kind to test
+     *            the kind to test
      * @return true if the given kind is a unary operator
      */
     private static boolean isUnaryOperator(Tree.Kind kind) {
@@ -1397,7 +1397,7 @@ implements Comparable<ASTPath>, Iterable<ASTPath.ASTEntry> {
      * Determines if the given kind is a binary operator.
      *
      * @param kind
-     *            The kind to test
+     *            the kind to test
      * @return true if the given kind is a binary operator
      */
     private static boolean isBinaryOperator(Tree.Kind kind) {
@@ -1426,7 +1426,7 @@ implements Comparable<ASTPath>, Iterable<ASTPath.ASTEntry> {
      * Determines if the given kind is a wildcard.
      *
      * @param kind
-     *            The kind to test
+     *            the kind to test
      * @return true if the given kind is a wildcard
      */
     private static boolean isWildcard(Tree.Kind kind) {
@@ -1457,7 +1457,7 @@ implements Comparable<ASTPath>, Iterable<ASTPath.ASTEntry> {
    * Determines if the given kind is a compound assignment.
    *
    * @param kind
-   *            The kind to test
+   *            the kind to test
    * @return true if the given kind is a compound assignment
    */
   public static boolean isCompoundAssignment(Tree.Kind kind) {
@@ -1478,7 +1478,7 @@ implements Comparable<ASTPath>, Iterable<ASTPath.ASTEntry> {
    * Determines if the given kind is a unary operator.
    *
    * @param kind
-   *            The kind to test
+   *            the kind to test
    * @return true if the given kind is a unary operator
    */
   public static boolean isUnaryOperator(Tree.Kind kind) {
@@ -1496,7 +1496,7 @@ implements Comparable<ASTPath>, Iterable<ASTPath.ASTEntry> {
    * Determines if the given kind is a binary operator.
    *
    * @param kind
-   *            The kind to test
+   *            the kind to test
    * @return true if the given kind is a binary operator
    */
   public static boolean isBinaryOperator(Tree.Kind kind) {
@@ -1574,7 +1574,7 @@ implements Comparable<ASTPath>, Iterable<ASTPath.ASTEntry> {
    * Determines if the given kind is a wildcard.
    *
    * @param kind
-   *            The kind to test
+   *            the kind to test
    * @return true if the given kind is a wildcard
    */
   public static boolean isWildcard(Tree.Kind kind) {
@@ -1587,7 +1587,7 @@ implements Comparable<ASTPath>, Iterable<ASTPath.ASTEntry> {
    * Determines if the given kind is a declaration.
    *
    * @param kind
-   *            The kind to test
+   *            the kind to test
    * @return true if the given kind is a declaration
    */
   public static boolean isDeclaration(Tree.Kind kind) {
@@ -1604,7 +1604,7 @@ implements Comparable<ASTPath>, Iterable<ASTPath.ASTEntry> {
    *  given kind.
    *
    * @param kind
-   *            The kind to test
+   *            the kind to test
    * @return true if the given kind can be identified by an {@code ASTPath}.
    */
   public static boolean isHandled(Tree.Kind kind) {
diff --git a/scene-lib/src/annotations/io/IndexFileParser.java b/scene-lib/src/annotations/io/IndexFileParser.java
index 0354cf5..330e202 100644
--- a/scene-lib/src/annotations/io/IndexFileParser.java
+++ b/scene-lib/src/annotations/io/IndexFileParser.java
@@ -1362,7 +1362,7 @@ public final class IndexFileParser {
      *
      * @param kind the kind of this AST entry
      * @param legalChildSelectors a list of the legal child selectors for this AST entry
-     * @return a new {@link ASTPath.ASTEntry}.
+     * @return a new {@link ASTPath.ASTEntry}
      * @throws ParseException if an illegal argument is found
      */
     private ASTPath.ASTEntry newASTEntry(Kind kind, String[] legalChildSelectors) throws IOException, ParseException {