Fix various javadoc link warnings

bug 23680, from Eric Johnson


git-svn-id: https://svn.apache.org/repos/asf/jakarta/commons/proper/collections/trunk@131268 13f79535-47bb-0310-9956-ffa450edef68

src/java/org/apache/commons/collections/comparators/NullComparator.java

@@ -1,5 +1,5 @@
 /*
- * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/comparators/NullComparator.java,v 1.8 2003/08/31 17:25:49 scolebourne Exp $
+ * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/comparators/NullComparator.java,v 1.9 2003/10/09 20:44:32 scolebourne Exp $
  * ====================================================================
  * The Apache Software License, Version 1.1
  *
@@ -64,10 +64,10 @@ import java.util.Comparator;
  * other objects.
  *
  * @since Commons Collections 2.0
- *  @version $Revision: 1.8 $ $Date: 2003/08/31 17:25:49 $ 
+ * @version $Revision: 1.9 $ $Date: 2003/10/09 20:44:32 $ 
  *
- *  @author <a href="mailto:mas@apache.org">Michael A. Smith</a>
+ * @author Michael A. Smith
- **/
+ */
 public class NullComparator implements Comparator, Serializable {
 
     /**
@@ -191,7 +191,7 @@ public class NullComparator implements Comparator, Serializable {
      *  Determines whether the specified object represents a comparator that is
      *  equal to this comparator.
      *
-     *  @param o the object to compare this comparator with.
+     *  @param obj  the object to compare this comparator with.
      *
      *  @return <code>true</code> if the specified object is a NullComparator
      *  with equivalent <code>null</code> comparison behavior

src/java/org/apache/commons/collections/decorators/SetList.java

@@ -1,5 +1,5 @@
 /*
- * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/decorators/Attic/SetList.java,v 1.2 2003/10/04 00:50:35 scolebourne Exp $
+ * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/decorators/Attic/SetList.java,v 1.3 2003/10/09 20:44:32 scolebourne Exp $
  * ====================================================================
  *
  * The Apache Software License, Version 1.1
@@ -75,13 +75,12 @@ import java.util.Set;
  * result of rejecting duplicates.
  * Each violation is explained in the method, but it should not affect you.
  * <p>
- * The {@link org.apache.commons.collections.decorators.OrderedSet OrderedSet}
+ * The {@link OrderedSet} class provides an alternative approach, by wrapping
- * class provides an alternative approach, by wrapping an existing Set and
+ * an existing Set and retaining insertion order in the iterator.
- * retaining insertion order in the iterator. This class offers the <code>List</code>
+ * This class offers the <code>List</code> interface implementation as well.
- * interface implementation as well.
  *
  * @since Commons Collections 3.0
- * @version $Revision: 1.2 $ $Date: 2003/10/04 00:50:35 $
+ * @version $Revision: 1.3 $ $Date: 2003/10/09 20:44:32 $
  * 
  * @author Matthew Hawthorne
  * @author Stephen Colebourne
@@ -193,8 +192,7 @@ public class SetList extends AbstractListDecorator {
      * The <code>List</code> interface makes the assumption that the element is
      * always inserted. This may not happen with this implementation.
      * 
-     * @param index  the index to insert at
+     * @param coll  the collection to add
-     * @param object  the object to add
      */
     public boolean addAll(Collection coll) {
         return addAll(size(), coll);

src/java/org/apache/commons/collections/iterators/ArrayListIterator.java

@@ -1,5 +1,5 @@
 /*
- * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/iterators/ArrayListIterator.java,v 1.7 2003/10/05 23:21:07 scolebourne Exp $
+ * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/iterators/ArrayListIterator.java,v 1.8 2003/10/09 20:44:32 scolebourne Exp $
  * ====================================================================
  *
  * The Apache Software License, Version 1.1
@@ -58,14 +58,14 @@
 package org.apache.commons.collections.iterators;
 
 import java.lang.reflect.Array;
+import java.util.ListIterator;
 import java.util.NoSuchElementException;
 
 /**
- * Implements a {@link java.util.ListIterator ListIterator} over an array. 
+ * Implements a {@link ListIterator} over an array. 
  * <p>
  * The array can be either an array of object or of primitives. If you know 
- * that you have an object array, the 
+ * that you have an object array, the {@link ObjectArrayListIterator}
- * {@link org.apache.commons.collections.iterators.ObjectArrayListIterator ObjectArrayListIterator}
  * class is a better choice, as it will perform better.
  * 
  * <p>
@@ -77,13 +77,14 @@ import java.util.NoSuchElementException;
  * @see java.util.ListIterator
  *
  * @since Commons Collections 3.0
- * @version $Revision: 1.7 $ $Date: 2003/10/05 23:21:07 $
+ * @version $Revision: 1.8 $ $Date: 2003/10/09 20:44:32 $
  *
  * @author Neil O'Toole
  * @author Stephen Colebourne
  * @author Phil Steitz
  */
-public class ArrayListIterator extends ArrayIterator implements ResetableListIterator {
+public class ArrayListIterator extends ArrayIterator
+		implements ListIterator, ResetableListIterator {
 
     /**
      * Holds the index of the last item returned by a call to <code>next()</code>

src/java/org/apache/commons/collections/iterators/ObjectArrayListIterator.java

@@ -1,5 +1,5 @@
 /*
- * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/iterators/ObjectArrayListIterator.java,v 1.7 2003/09/29 03:56:12 psteitz Exp $
+ * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/iterators/ObjectArrayListIterator.java,v 1.8 2003/10/09 20:44:32 scolebourne Exp $
  * ====================================================================
  *
  * The Apache Software License, Version 1.1
@@ -57,6 +57,7 @@
  */
 package org.apache.commons.collections.iterators;
 
+import java.util.ListIterator;
 import java.util.NoSuchElementException;
 
 /**
@@ -73,13 +74,14 @@ import java.util.NoSuchElementException;
  * @see java.util.ListIterator
  *
  * @since Commons Collections 3.0
- * @version $Revision: 1.7 $ $Date: 2003/09/29 03:56:12 $
+ * @version $Revision: 1.8 $ $Date: 2003/10/09 20:44:32 $
  * 
  * @author <a href="mailto:neilotoole@users.sourceforge.net">Neil O'Toole</a>
  * @author Stephen Colebourne
  * @author Phil Steitz
  */
-public class ObjectArrayListIterator extends ObjectArrayIterator implements ResetableListIterator {
+public class ObjectArrayListIterator extends ObjectArrayIterator
+		implements ListIterator, ResetableListIterator {
 
     /**
      * Holds the index of the last item returned by a call to <code>next()</code> 

src/java/org/apache/commons/collections/iterators/SingletonIterator.java

@@ -1,5 +1,5 @@
 /*
- * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/iterators/SingletonIterator.java,v 1.7 2003/10/09 11:05:27 rwaldhoff Exp $
+ * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/iterators/SingletonIterator.java,v 1.8 2003/10/09 20:44:32 scolebourne Exp $
  * ====================================================================
  *
  * The Apache Software License, Version 1.1
@@ -57,20 +57,22 @@
  */
 package org.apache.commons.collections.iterators;
 
+import java.util.Iterator;
 import java.util.NoSuchElementException;
 
 /** 
- * <p><code>SingletonIterator</code> is an {@link Iterator} over a single 
+ * <code>SingletonIterator</code> is an {@link Iterator} over a single 
- * object instance.</p>
+ * object instance.
  *
  * @since Commons Collections 2.0
- * @version $Revision: 1.7 $ $Date: 2003/10/09 11:05:27 $
+ * @version $Revision: 1.8 $ $Date: 2003/10/09 20:44:32 $
  * 
- * @author <a href="mailto:jstrachan@apache.org">James Strachan</a>
+ * @author James Strachan
  * @author Stephen Colebourne
  * @author Rodney Waldhoff
  */
-public class SingletonIterator implements ResetableIterator {
+public class SingletonIterator
+		implements Iterator, ResetableIterator {
 
     private boolean beforeFirst = true;
     private boolean removed = false;

src/java/org/apache/commons/collections/iterators/SingletonListIterator.java

@@ -1,5 +1,5 @@
 /*
- * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/iterators/SingletonListIterator.java,v 1.7 2003/10/09 11:05:27 rwaldhoff Exp $
+ * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/iterators/SingletonListIterator.java,v 1.8 2003/10/09 20:44:32 scolebourne Exp $
  * ====================================================================
  *
  * The Apache Software License, Version 1.1
@@ -57,18 +57,21 @@
  */
 package org.apache.commons.collections.iterators;
 
+import java.util.ListIterator;
 import java.util.NoSuchElementException;
+
 /**
- * <p><code>SingletonIterator</code> is an {@link ListIterator} over a single 
+ * <code>SingletonIterator</code> is an {@link ListIterator} over a single 
- * object instance.</p>
+ * object instance.
  *
  * @since Commons Collections 2.1
- * @version $Revision: 1.7 $ $Date: 2003/10/09 11:05:27 $
+ * @version $Revision: 1.8 $ $Date: 2003/10/09 20:44:32 $
  * 
  * @author Stephen Colebourne
  * @author Rodney Waldhoff
  */
-public class SingletonListIterator implements ResetableListIterator {
+public class SingletonListIterator
+		implements ListIterator, ResetableListIterator {
 
     private boolean beforeFirst = true;
     private boolean nextCalled = false;