Clarify javadoc

from Simon Kitching


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

src/java/org/apache/commons/collections/BidiMap.java

@@ -26,9 +26,14 @@ package org.apache.commons.collections;
  * <p>
  * Implementations should allow a value to be looked up from a key and
  * a key to be looked up from a value with equal performance.
+ * <p>
+ * This map enforces the restriction that there is a 1:1 relation between
+ * keys and values, meaning that multiple keys cannot map to the same value. 
+ * This is required so that "inverting" the map results in a map without 
+ * duplicate keys. See the {@link #put} method description for more information.
  * 
  * @since Commons Collections 3.0
- * @version $Revision: 1.14 $ $Date: 2004/02/18 01:15:42 $
+ * @version $Revision: 1.15 $ $Date: 2004/04/14 20:15:42 $
  *
  * @author Stephen Colebourne
  */

src/java/org/apache/commons/collections/BoundedCollection.java

@@ -24,8 +24,11 @@ import java.util.Collection;
  * maximum number of elements. This interface allows the querying of details
  * associated with the maximum number of elements.
  *
+ * @see CollectionUtils#isFull
+ * @see CollectionUtils#maxSize
+ *
  * @since Commons Collections 3.0
- * @version $Revision: 1.10 $ $Date: 2004/02/18 01:15:42 $
+ * @version $Revision: 1.11 $ $Date: 2004/04/14 20:13:11 $
  * 
  * @author Herve Quiroz
  * @author Stephen Colebourne

src/java/org/apache/commons/collections/collection/UnmodifiableBoundedCollection.java

@@ -22,16 +22,17 @@ import org.apache.commons.collections.BoundedCollection;
 import org.apache.commons.collections.iterators.UnmodifiableIterator;
 
 /**
- * <code>UnmodifiableBoundedCollection</code> decorates another <code>BoundedCollection</code>
- * to ensure it can't be altered.
+ * <code>UnmodifiableBoundedCollection</code> decorates another 
+ * <code>BoundedCollection</code> to ensure it can't be altered.
  * <p>
  * If a BoundedCollection is first wrapped in some other collection decorator,
- * such as synchronized or predicated, the BoundedCollection nature is lost.
+ * such as synchronized or predicated, the BoundedCollection methods are no 
+ * longer accessible.
  * The factory on this class will attempt to retrieve the bounded nature by
  * examining the package scope variables.
  *
  * @since Commons Collections 3.0
- * @version $Revision: 1.6 $ $Date: 2004/02/18 00:58:53 $
+ * @version $Revision: 1.7 $ $Date: 2004/04/14 20:11:45 $
  * 
  * @author Stephen Colebourne
  */