From 28d5e308a1d3746f7ee6656ddfa3a8817477fc73 Mon Sep 17 00:00:00 2001
From: Sebastian Bazley <sebb@apache.org>
Date: Sat, 10 Mar 2012 14:28:37 +0000
Subject: [PATCH] Javadoc fixes

git-svn-id: https://svn.apache.org/repos/asf/commons/proper/collections/trunk@1299209 13f79535-47bb-0310-9956-ffa450edef68
---
 .../org/apache/commons/collections/ComparatorUtils.java   | 2 +-
 .../apache/commons/collections/ExtendedProperties.java    | 2 +-
 src/main/java/org/apache/commons/collections/Get.java     | 2 +-
 .../java/org/apache/commons/collections/IterableGet.java  | 2 +-
 .../org/apache/commons/collections/IterableSortedMap.java | 2 +-
 .../java/org/apache/commons/collections/MapUtils.java     | 4 ++--
 src/main/java/org/apache/commons/collections/Put.java     | 2 +-
 .../collections/functors/CatchAndRethrowClosure.java      | 2 +-
 .../org/apache/commons/collections/functors/Equator.java  | 4 ++--
 .../commons/collections/map/AbstractIterableMap.java      | 2 +-
 .../apache/commons/collections/map/AbstractLinkedMap.java | 2 +-
 .../commons/collections/map/AbstractReferenceMap.java     | 8 ++++++--
 .../org/apache/commons/collections/map/DefaultedMap.java  | 3 ++-
 .../collections/map/EntrySetToMapIteratorAdapter.java     | 2 +-
 .../apache/commons/collections/map/ListOrderedMap.java    | 2 +-
 .../collections/collection/AbstractTestCollection.java    | 5 +++--
 .../collections/iterators/TestFilterListIterator.java     | 2 +-
 .../commons/collections/splitmap/TestSplitMapUtils.java   | 2 +-
 .../commons/collections/splitmap/TestTransformedMap.java  | 2 +-
 19 files changed, 29 insertions(+), 23 deletions(-)

diff --git a/src/main/java/org/apache/commons/collections/ComparatorUtils.java b/src/main/java/org/apache/commons/collections/ComparatorUtils.java
index 3f058a7c8..c05146b43 100644
--- a/src/main/java/org/apache/commons/collections/ComparatorUtils.java
+++ b/src/main/java/org/apache/commons/collections/ComparatorUtils.java
@@ -52,7 +52,7 @@ public class ComparatorUtils {
     /**
      * Comparator for natural sort order.
      *
-     * @see ComparableComparator#getInstance
+     * @see ComparableComparator#comparableComparator()
      */
     @SuppressWarnings("unchecked")
     public static final Comparator NATURAL_COMPARATOR = ComparableComparator.<Comparable>comparableComparator();
diff --git a/src/main/java/org/apache/commons/collections/ExtendedProperties.java b/src/main/java/org/apache/commons/collections/ExtendedProperties.java
index 39270dedd..7aac70717 100644
--- a/src/main/java/org/apache/commons/collections/ExtendedProperties.java
+++ b/src/main/java/org/apache/commons/collections/ExtendedProperties.java
@@ -44,7 +44,7 @@ import java.util.Vector;
  * instead of overwriting them.
  * <p>
  * <b>Please consider using the
- * {@link org.apache.commons.configuration.PropertiesConfiguration} class in
+ * {@code org.apache.commons.configuration.PropertiesConfiguration} class in
  * <a href="http://commons.apache.org/configuration">Commons Configuration</a>.
  * It's an evolution of <code>ExtendedProperties</code> supporting more
  * features like automatic reloading, advanced interpolation, more type
diff --git a/src/main/java/org/apache/commons/collections/Get.java b/src/main/java/org/apache/commons/collections/Get.java
index 060787b32..8627655e3 100644
--- a/src/main/java/org/apache/commons/collections/Get.java
+++ b/src/main/java/org/apache/commons/collections/Get.java
@@ -23,7 +23,7 @@ import java.util.Set;
 /**
  * The "read" subset of the {@link Map} interface.
  * @since Commons Collections 5
- * @TODO fix version
+ * TODO fix version
  * @version $Revision$ $Date$
  * @see Put
  * @author Matt Benson
diff --git a/src/main/java/org/apache/commons/collections/IterableGet.java b/src/main/java/org/apache/commons/collections/IterableGet.java
index 5d2cb71f3..c5e92d7b4 100644
--- a/src/main/java/org/apache/commons/collections/IterableGet.java
+++ b/src/main/java/org/apache/commons/collections/IterableGet.java
@@ -21,7 +21,7 @@ import java.util.Map;
 /**
  * The "read" subset of the {@link Map} interface.
  * @since Commons Collections 5
- * @TODO fix version
+ * TODO fix version
  * @version $Revision$ $Date$
  * @see Put
  * @author Matt Benson
diff --git a/src/main/java/org/apache/commons/collections/IterableSortedMap.java b/src/main/java/org/apache/commons/collections/IterableSortedMap.java
index b902dd30e..01b0e05f9 100644
--- a/src/main/java/org/apache/commons/collections/IterableSortedMap.java
+++ b/src/main/java/org/apache/commons/collections/IterableSortedMap.java
@@ -24,7 +24,7 @@ import java.util.SortedMap;
  * @param <K> the type of the keys in the map
  * @param <V> the type of the values in the map
  * @since Commons Collections 5
- * @TODO fix version
+ * TODO fix version
  * @version $Revision$ $Date$
  *
  * @author Matt Benson
diff --git a/src/main/java/org/apache/commons/collections/MapUtils.java b/src/main/java/org/apache/commons/collections/MapUtils.java
index 39df30a80..662d5cd46 100644
--- a/src/main/java/org/apache/commons/collections/MapUtils.java
+++ b/src/main/java/org/apache/commons/collections/MapUtils.java
@@ -1649,7 +1649,7 @@ public class MapUtils {
      * @param map to wrap if necessary.
      * @return IterableMap<K, V>
      * @since Commons Collections 5
-     * @TODO fix version
+     * TODO fix version
      */
     public static <K, V> IterableMap<K, V> iterableMap(Map<K, V> map) {
         if (map == null) {
@@ -1667,7 +1667,7 @@ public class MapUtils {
      * @param sortedMap to wrap if necessary
      * @return {@link IterableSortedMap}<K, V>
      * @since Commons Collections 5
-     * @TODO fix version
+     * TODO fix version
      */
     public static <K, V> IterableSortedMap<K, V> iterableSortedMap(SortedMap<K, V> sortedMap) {
         if (sortedMap == null) {
diff --git a/src/main/java/org/apache/commons/collections/Put.java b/src/main/java/org/apache/commons/collections/Put.java
index fb61fa7b0..261758277 100644
--- a/src/main/java/org/apache/commons/collections/Put.java
+++ b/src/main/java/org/apache/commons/collections/Put.java
@@ -21,7 +21,7 @@ import java.util.Map;
 /**
  * The "write" subset of the {@link Map} interface.
  * @since Commons Collections 5
- * @TODO fix version
+ * TODO fix version
  * @version $Revision$ $Date$
  * @see Get
  * @author Matt Benson
diff --git a/src/main/java/org/apache/commons/collections/functors/CatchAndRethrowClosure.java b/src/main/java/org/apache/commons/collections/functors/CatchAndRethrowClosure.java
index 10c1cebc7..062b1f096 100644
--- a/src/main/java/org/apache/commons/collections/functors/CatchAndRethrowClosure.java
+++ b/src/main/java/org/apache/commons/collections/functors/CatchAndRethrowClosure.java
@@ -52,7 +52,7 @@ public abstract class CatchAndRethrowClosure<E> implements Closure<E> {
      * Execute this closure on the specified input object.
      * 
      * @param input the input to execute on
-     * @throws ClosureException (runtime) if the closure execution resulted in a
+     * @throws FunctorException (runtime) if the closure execution resulted in a
      *             checked exception.
      */
     public void execute(E input) {
diff --git a/src/main/java/org/apache/commons/collections/functors/Equator.java b/src/main/java/org/apache/commons/collections/functors/Equator.java
index 913aa0941..be147622e 100644
--- a/src/main/java/org/apache/commons/collections/functors/Equator.java
+++ b/src/main/java/org/apache/commons/collections/functors/Equator.java
@@ -38,8 +38,8 @@ public interface Equator<T> {
 
     /**
      * Calculates the hash for the object, based on the method of equality used in the equate
-     * method. This is used for classes that delegate their {@link #equals(Object)} method to an
-     * Equator (and so must also delegate their {@link #hashCode()} method), or for implementations
+     * method. This is used for classes that delegate their {@link Object#equals(Object) equals(Object)} method to an
+     * Equator (and so must also delegate their {@link Object#hashCode() hashCode()} method), or for implementations
      * of {@link HashedMap} that use an Equator for the key objects.
      * 
      * @param o the object to calculate the hash for.
diff --git a/src/main/java/org/apache/commons/collections/map/AbstractIterableMap.java b/src/main/java/org/apache/commons/collections/map/AbstractIterableMap.java
index 199f7f429..60dd566f4 100644
--- a/src/main/java/org/apache/commons/collections/map/AbstractIterableMap.java
+++ b/src/main/java/org/apache/commons/collections/map/AbstractIterableMap.java
@@ -22,7 +22,7 @@ import org.apache.commons.collections.MapIterator;
 /**
  * Provide a basic {@link IterableMap} implementation.
  * @since Commons Collections 5
- * @TODO fix version
+ * TODO fix version
  * @version $Revision$ $Date$
  *
  * @author Matt Benson
diff --git a/src/main/java/org/apache/commons/collections/map/AbstractLinkedMap.java b/src/main/java/org/apache/commons/collections/map/AbstractLinkedMap.java
index a04bcc977..6a7872f01 100644
--- a/src/main/java/org/apache/commons/collections/map/AbstractLinkedMap.java
+++ b/src/main/java/org/apache/commons/collections/map/AbstractLinkedMap.java
@@ -258,7 +258,7 @@ public abstract class AbstractLinkedMap<K, V> extends AbstractHashedMap<K, V> im
      * This implementation adds the entry to the data storage table and
      * to the end of the linked list.
      * 
-     * @param link  the entry to add
+     * @param entry  the entry to add
      * @param hashIndex  the index into the data array to store at
      */
     @Override
diff --git a/src/main/java/org/apache/commons/collections/map/AbstractReferenceMap.java b/src/main/java/org/apache/commons/collections/map/AbstractReferenceMap.java
index fc8996c2f..78371bd36 100644
--- a/src/main/java/org/apache/commons/collections/map/AbstractReferenceMap.java
+++ b/src/main/java/org/apache/commons/collections/map/AbstractReferenceMap.java
@@ -152,9 +152,13 @@ public abstract class AbstractReferenceMap<K, V> extends AbstractHashedMap<K, V>
      * load factor and initial capacity.
      *
      * @param keyType  the type of reference to use for keys;
-     *   must be {@link #HARD}, {@link #SOFT}, {@link #WEAK}
+     *   must be {@link ReferenceStrength#HARD HARD}, 
+     *   {@link ReferenceStrength#SOFT SOFT}, 
+     *   {@link ReferenceStrength#WEAK WEAK}
      * @param valueType  the type of reference to use for values;
-     *   must be {@link #HARD}, {@link #SOFT}, {@link #WEAK}
+     *   must be {@link ReferenceStrength#HARD},
+     *   {@link ReferenceStrength#SOFT SOFT},
+     *   {@link ReferenceStrength#WEAK WEAK}
      * @param capacity  the initial capacity for the map
      * @param loadFactor  the load factor for the map
      * @param purgeValues  should the value be automatically purged when the
diff --git a/src/main/java/org/apache/commons/collections/map/DefaultedMap.java b/src/main/java/org/apache/commons/collections/map/DefaultedMap.java
index ef138d1e5..3fb69a9aa 100644
--- a/src/main/java/org/apache/commons/collections/map/DefaultedMap.java
+++ b/src/main/java/org/apache/commons/collections/map/DefaultedMap.java
@@ -149,8 +149,9 @@ public class DefaultedMap<K, V> extends AbstractMapDecorator<K, V> implements Se
      * Constructor that wraps (not copies).
      * 
      * @param map  the map to decorate, must not be null
-     * @param value  the value to use
+     * @param defaultValueTransformer  the value transformer to use
      * @throws IllegalArgumentException if map or transformer is null
+     * TODO does not check for null transformer: fix code or Javadoc
      */
     protected DefaultedMap(Map<K, V> map, Transformer<? super K, ? extends V> defaultValueTransformer) {
         super(map);
diff --git a/src/main/java/org/apache/commons/collections/map/EntrySetToMapIteratorAdapter.java b/src/main/java/org/apache/commons/collections/map/EntrySetToMapIteratorAdapter.java
index 287af67c1..2778f5546 100644
--- a/src/main/java/org/apache/commons/collections/map/EntrySetToMapIteratorAdapter.java
+++ b/src/main/java/org/apache/commons/collections/map/EntrySetToMapIteratorAdapter.java
@@ -27,7 +27,7 @@ import org.apache.commons.collections.ResettableIterator;
  * Adapts a Map entrySet to the MapIterator interface.
  *
  * @since Commons Collections 5
- * @TODO fix version
+ * TODO fix version
  * @version $Revision$ $Date$
  *
  * @author Matt Benson
diff --git a/src/main/java/org/apache/commons/collections/map/ListOrderedMap.java b/src/main/java/org/apache/commons/collections/map/ListOrderedMap.java
index f5f43aa54..1767c6a0b 100644
--- a/src/main/java/org/apache/commons/collections/map/ListOrderedMap.java
+++ b/src/main/java/org/apache/commons/collections/map/ListOrderedMap.java
@@ -62,7 +62,7 @@ import org.apache.commons.collections.list.UnmodifiableList;
  * {@link CaseInsensitiveMap}, or similar maps that violate the general
  * contract of {@link java.util.Map}.</strong> The <code>ListOrderedMap</code>
  * (or, more precisely, the underlying <code>List</code>) is relying on
- * {@link Object#java.lang.equals(Object) equals()}. This is fine, as long as the
+ * {@link Object#equals(Object) equals()}. This is fine, as long as the
  * decorated <code>Map</code> is also based on {@link Object#equals(Object) equals()},
  * and {@link Object#hashCode() hashCode()}, which {@link IdentityMap}, and
  * {@link CaseInsensitiveMap} don't: The former uses <code>==</code>, and
diff --git a/src/test/java/org/apache/commons/collections/collection/AbstractTestCollection.java b/src/test/java/org/apache/commons/collections/collection/AbstractTestCollection.java
index 3b7e786af..ce5fdebac 100644
--- a/src/test/java/org/apache/commons/collections/collection/AbstractTestCollection.java
+++ b/src/test/java/org/apache/commons/collections/collection/AbstractTestCollection.java
@@ -41,8 +41,9 @@ import org.apache.commons.collections.AbstractTestObject;
  * <p>
  * You should create a concrete subclass of this class to test any custom
  * {@link Collection} implementation.  At minimum, you'll have to
- * implement the {@link #makeCollection()} method.  You might want to
- * override some of the additional public methods as well:
+ * implement the @{@link #makeObject()}, {@link #makeConfirmedCollection()}
+ * and {@link #makeConfirmedFullCollection()} methods.
+ * You might want to override some of the additional public methods as well:
  * <p>
  * <b>Element Population Methods</b>
  * <p>
diff --git a/src/test/java/org/apache/commons/collections/iterators/TestFilterListIterator.java b/src/test/java/org/apache/commons/collections/iterators/TestFilterListIterator.java
index a18514db8..9d7807e77 100644
--- a/src/test/java/org/apache/commons/collections/iterators/TestFilterListIterator.java
+++ b/src/test/java/org/apache/commons/collections/iterators/TestFilterListIterator.java
@@ -284,7 +284,7 @@ public class TestFilterListIterator extends TestCase {
     }
 
     /**
-     * Test for {@link https://issues.apache.org/jira/browse/COLLECTIONS-360 COLLECTIONS-360}.
+     * Test for {@link "https://issues.apache.org/jira/browse/COLLECTIONS-360 COLLECTIONS-360"}
      */
     public void testCollections360() throws Throwable {
         Collection<Predicate<Object>> var7 = new GrowthList<Predicate<Object>>();
diff --git a/src/test/java/org/apache/commons/collections/splitmap/TestSplitMapUtils.java b/src/test/java/org/apache/commons/collections/splitmap/TestSplitMapUtils.java
index 0c33dd69b..ba0467494 100644
--- a/src/test/java/org/apache/commons/collections/splitmap/TestSplitMapUtils.java
+++ b/src/test/java/org/apache/commons/collections/splitmap/TestSplitMapUtils.java
@@ -32,7 +32,7 @@ import org.apache.commons.collections.map.HashedMap;
  * Tests for {@link TransformedMap}
  *
  * @since Commons Collections 5
- * @TODO fix version
+ * TODO fix version
  * @version $Revision$ $Date$
  *
  * @author Stephen Colebourne
diff --git a/src/test/java/org/apache/commons/collections/splitmap/TestTransformedMap.java b/src/test/java/org/apache/commons/collections/splitmap/TestTransformedMap.java
index 890d85b43..1f95db0f1 100644
--- a/src/test/java/org/apache/commons/collections/splitmap/TestTransformedMap.java
+++ b/src/test/java/org/apache/commons/collections/splitmap/TestTransformedMap.java
@@ -29,7 +29,7 @@ import org.apache.commons.collections.functors.NOPTransformer;
  * Tests for {@link TransformedMap}
  *
  * @since Commons Collections 5
- * @TODO fix version, add Serialization tests
+ * TODO fix version, add Serialization tests
  * @version $Revision$ $Date$
  *
  * @author Stephen Colebourne