Javadoc improvements

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

src/java/org/apache/commons/collections/decorators/FixedSizeList.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/FixedSizeList.java,v 1.3 2003/05/07 11:20:21 scolebourne Exp $
+ * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/decorators/Attic/FixedSizeList.java,v 1.4 2003/05/07 12:18:55 scolebourne Exp $
  * ====================================================================
  *
  * The Apache Software License, Version 1.1
@@ -62,14 +62,14 @@ import java.util.List;
 import java.util.ListIterator;
 
 /**
- * <code>FixedSizeList</code> decorates another <code>List</code> to
- * fix the size.
+ * <code>FixedSizeList</code> decorates another <code>List</code>
+ * to fix the size.
  * <p>
  * The add, remove, clear and retain operations are unsupported.
  * The set method is allowed (as it doesn't change the list size).
  *
  * @since Commons Collections 3.0
- * @version $Revision: 1.3 $ $Date: 2003/05/07 11:20:21 $
+ * @version $Revision: 1.4 $ $Date: 2003/05/07 12:18:55 $
  * 
  * @author Stephen Colebourne
  * @author Paul Jack

src/java/org/apache/commons/collections/decorators/SynchronizedCollection.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/SynchronizedCollection.java,v 1.2 2003/05/07 11:20:21 scolebourne Exp $
+ * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/decorators/Attic/SynchronizedCollection.java,v 1.3 2003/05/07 12:18:55 scolebourne Exp $
  * ====================================================================
  *
  * The Apache Software License, Version 1.1
@@ -62,7 +62,7 @@ import java.util.Iterator;
 
 /**
  * <code>SynchronizedCollection</code> decorates another <code>Collection</code>
- * to synchronize the method calls.
+ * to synchronize its behaviour for a multi-threaded environment.
  * <p>
  * Iterators must be manually synchronized:
  * <pre>
@@ -72,7 +72,7 @@ import java.util.Iterator;
  * }
  *
  * @since Commons Collections 3.0
- * @version $Revision: 1.2 $ $Date: 2003/05/07 11:20:21 $
+ * @version $Revision: 1.3 $ $Date: 2003/05/07 12:18:55 $
  * 
  * @author Stephen Colebourne
  */

src/java/org/apache/commons/collections/decorators/SynchronizedList.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/SynchronizedList.java,v 1.3 2003/05/07 11:20:21 scolebourne Exp $
+ * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/decorators/Attic/SynchronizedList.java,v 1.4 2003/05/07 12:18:55 scolebourne Exp $
  * ====================================================================
  *
  * The Apache Software License, Version 1.1
@@ -62,12 +62,13 @@ import java.util.List;
 import java.util.ListIterator;
 
 /**
- * <code>SynchronizedList</code> decorates another <code>List</code>.
+ * <code>SynchronizedList</code> decorates another <code>List</code>
+ * to synchronize its behaviour for a multi-threaded environment.
  * <p>
  * Methods are synchronized, then forwarded to the decorated list.
  *
  * @since Commons Collections 3.0
- * @version $Revision: 1.3 $ $Date: 2003/05/07 11:20:21 $
+ * @version $Revision: 1.4 $ $Date: 2003/05/07 12:18:55 $
  * 
  * @author Stephen Colebourne
  */

src/java/org/apache/commons/collections/decorators/SynchronizedSet.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/SynchronizedSet.java,v 1.1 2003/05/07 11:19:46 scolebourne Exp $
+ * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/decorators/Attic/SynchronizedSet.java,v 1.2 2003/05/07 12:18:55 scolebourne Exp $
  * ====================================================================
  *
  * The Apache Software License, Version 1.1
@@ -60,12 +60,13 @@ package org.apache.commons.collections.decorators;
 import java.util.Set;
 
 /**
- * <code>SynchronizedSet</code> decorates another <code>Set</code>.
+ * <code>SynchronizedSet</code> decorates another <code>Set</code>
+ * to synchronize its behaviour for a multi-threaded environment.
  * <p>
  * Methods are synchronized, then forwarded to the decorated set.
  *
  * @since Commons Collections 3.0
- * @version $Revision: 1.1 $ $Date: 2003/05/07 11:19:46 $
+ * @version $Revision: 1.2 $ $Date: 2003/05/07 12:18:55 $
  * 
  * @author Stephen Colebourne
  */

src/java/org/apache/commons/collections/decorators/SynchronizedSortedSet.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/SynchronizedSortedSet.java,v 1.1 2003/05/07 11:19:46 scolebourne Exp $
+ * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/decorators/Attic/SynchronizedSortedSet.java,v 1.2 2003/05/07 12:18:55 scolebourne Exp $
  * ====================================================================
  *
  * The Apache Software License, Version 1.1
@@ -61,12 +61,13 @@ import java.util.Comparator;
 import java.util.SortedSet;
 
 /**
- * <code>SynchronizedSortedSet</code> decorates another <code>SortedSet</code>.
+ * <code>SynchronizedSortedSet</code> decorates another <code>SortedSet</code>
+ * to synchronize its behaviour for a multi-threaded environment.
  * <p>
  * Methods are synchronized, then forwarded to the decorated set.
  *
  * @since Commons Collections 3.0
- * @version $Revision: 1.1 $ $Date: 2003/05/07 11:19:46 $
+ * @version $Revision: 1.2 $ $Date: 2003/05/07 12:18:55 $
  * 
  * @author Stephen Colebourne
  */

src/java/org/apache/commons/collections/decorators/UnmodifiableCollection.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/UnmodifiableCollection.java,v 1.3 2003/05/07 11:20:21 scolebourne Exp $
+ * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/decorators/Attic/UnmodifiableCollection.java,v 1.4 2003/05/07 12:18:55 scolebourne Exp $
  * ====================================================================
  *
  * The Apache Software License, Version 1.1
@@ -63,14 +63,11 @@ import java.util.Iterator;
 import org.apache.commons.collections.IteratorUtils;
 
 /**
- * <code>PredicatedCollection</code> decorates another <code>Collection</code>
- * to validate addition match a specified predicate.
- * <p>
- * If an object cannot be addded to the collection, an IllegalArgumentException
- * is thrown.
+ * <code>UnmodifiableCollection</code> decorates another <code>Collection</code>
+ * to ensure it can't be altered.
  *
  * @since Commons Collections 3.0
- * @version $Revision: 1.3 $ $Date: 2003/05/07 11:20:21 $
+ * @version $Revision: 1.4 $ $Date: 2003/05/07 12:18:55 $
  * 
  * @author Stephen Colebourne
  */