Apache
/
commons-collections
mirror of https://github.com/apache/commons-collections.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Improve documentation 

git-svn-id: https://svn.apache.org/repos/asf/jakarta/commons/proper/collections/trunk@131463 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Stephen Colebourne 2003-12-28 17:59:47 +00:00
parent ac7b2ec527
commit df7cafe578
6 changed files with 25 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
src/java/org/apache/commons/collections/SequencedHashMap.java
View File

@ -1,5 +1,5 @@
/*
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/SequencedHashMap.java,v 1.23 2003/12/06 13:03:15 scolebourne Exp $
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/SequencedHashMap.java,v 1.24 2003/12/28 17:59:47 scolebourne Exp $
* ====================================================================
*
* The Apache Software License, Version 1.1
@ -86,12 +86,12 @@ import org.apache.commons.collections.list.UnmodifiableList;
* (see: {@link java.util.List#remove(Object)} and {@link java.util.Map#remove(Object)}).
* <p>
* This class is not thread safe. When a thread safe implementation is
* required, use {@link Collections#synchronizedMap(Map)} as it is documented,
* required, use {@link java.util.Collections#synchronizedMap(Map)} as it is documented,
* or use explicit synchronization controls.
*
* @see org.apache.commons.collections.set.ListOrderedSet
* @since Commons Collections 2.0
* @version $Revision: 1.23 $ $Date: 2003/12/06 13:03:15 $
* @version $Revision: 1.24 $ $Date: 2003/12/28 17:59:47 $
*
* @author Michael A. Smith
* @author Daniel Rall

8
src/java/org/apache/commons/collections/bag/TreeBag.java
View File

@ -1,5 +1,5 @@
/*
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/bag/TreeBag.java,v 1.4 2003/12/28 16:36:48 scolebourne Exp $
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/bag/TreeBag.java,v 1.5 2003/12/28 17:58:53 scolebourne Exp $
* ====================================================================
*
* The Apache Software License, Version 1.1
@ -82,7 +82,7 @@ import org.apache.commons.collections.SortedBag;
* <code>Collection</code> interface specification.
*
* @since Commons Collections 3.0 (previously in main package v2.0)
* @version $Revision: 1.4 $ $Date: 2003/12/28 16:36:48 $
* @version $Revision: 1.5 $ $Date: 2003/12/28 17:58:53 $
*
* @author Chuck Burdick
* @author Stephen Colebourne
@ -110,8 +110,8 @@ public class TreeBag extends AbstractMapBag implements SortedBag, Serializable {
}
/**
* Constructs a {@link Bag} containing all the members of the given
* collection.
* Constructs a <code>TreeBag</code> containing all the members of the
* specified collection.
*
* @param coll the collection to copy into the bag
*/

11
src/java/org/apache/commons/collections/buffer/BinaryHeap.java
View File

@ -1,5 +1,5 @@
/*
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/buffer/Attic/BinaryHeap.java,v 1.2 2003/12/28 16:36:48 scolebourne Exp $
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/buffer/Attic/BinaryHeap.java,v 1.3 2003/12/28 17:58:54 scolebourne Exp $
* ====================================================================
*
* The Apache Software License, Version 1.1
@ -67,7 +67,8 @@ import org.apache.commons.collections.BufferUnderflowException;
import org.apache.commons.collections.PriorityQueue;
/**
* Binary heap implementation of {@link PriorityQueue} and {@link Buffer}.
* Binary heap implementation of <code>PriorityQueue</code> that provides for
* removal based on <code>Comparator</code> ordering.
* <p>
* The removal order of a binary heap is based on either the natural sort
* order of its elements or a specified {@link Comparator}. The
@ -83,15 +84,15 @@ import org.apache.commons.collections.PriorityQueue;
* time. All other operations perform in linear time or worse.
* <p>
* Note that this implementation is not synchronized. Use
* {@link BufferUtils#synchronizedBuffer(Buffer)} to provide
* synchronized access to a <code>BinaryHeap</code>:
* {@link org.apache.commons.collections.PriorityQueueUtils#synchronizedPriorityQueue(PriorityQueue)}
* to provide synchronized access to a <code>BinaryHeap</code>:
*
* <pre>
* Buffer heap = BufferUtils.synchronizedBuffer(new BinaryHeap());
* </pre>
*
* @since Commons Collections 3.0 (previously in main package v1.0)
* @version $Revision: 1.2 $ $Date: 2003/12/28 16:36:48 $
* @version $Revision: 1.3 $ $Date: 2003/12/28 17:58:54 $
*
* @author Peter Donald
* @author Ram Chidambaram

8
src/java/org/apache/commons/collections/list/AbstractLinkedList.java
View File

@ -1,5 +1,5 @@
/*
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/list/AbstractLinkedList.java,v 1.2 2003/12/24 01:15:40 scolebourne Exp $
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/list/AbstractLinkedList.java,v 1.3 2003/12/28 17:58:54 scolebourne Exp $
* ====================================================================
*
* The Apache Software License, Version 1.1
@ -80,7 +80,7 @@ import org.apache.commons.collections.OrderedIterator;
* is here.
*
* @since Commons Collections 3.0
* @version $Revision: 1.2 $ $Date: 2003/12/24 01:15:40 $
* @version $Revision: 1.3 $ $Date: 2003/12/28 17:58:54 $
*
* @author Rich Dougherty
* @author Phil Steitz
@ -685,12 +685,12 @@ public abstract class AbstractLinkedList implements List {
/**
* The node that will be returned by {@link #next()}. If this is equal
* to {@link #marker} then there are no more values to return.
* to {@link AbstractLinkedList#header} then there are no more values to return.
*/
protected Node next;
/**
* The index of {@link #nextNode}.
* The index of {@link #next}.
*/
protected int nextIndex;

6
src/java/org/apache/commons/collections/map/HashedMap.java
View File

@ -1,5 +1,5 @@
/*
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/map/HashedMap.java,v 1.10 2003/12/28 16:36:48 scolebourne Exp $
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/map/HashedMap.java,v 1.11 2003/12/28 17:58:53 scolebourne Exp $
* ====================================================================
*
* The Apache Software License, Version 1.1
@ -68,11 +68,11 @@ import java.util.Map;
* to <code>HashMap</code>.
* <p>
* This implementation improves on the JDK1.4 HahMap by adding the
* {@link org.apache.commons.collections.iterators.MapIterator MapIterator}
* {@link org.apache.commons.collections.MapIterator MapIterator}
* functionality and many methods for subclassing.
* <p>
* @since Commons Collections 3.0
* @version $Revision: 1.10 $ $Date: 2003/12/28 16:36:48 $
* @version $Revision: 1.11 $ $Date: 2003/12/28 17:58:53 $
*
* @author Stephen Colebourne
*/

6
src/java/org/apache/commons/collections/map/LinkedMap.java
View File

@ -1,5 +1,5 @@
/*
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/map/LinkedMap.java,v 1.4 2003/12/07 23:59:13 scolebourne Exp $
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/map/LinkedMap.java,v 1.5 2003/12/28 17:58:54 scolebourne Exp $
* ====================================================================
*
* The Apache Software License, Version 1.1
@ -68,7 +68,7 @@ import java.util.Map;
* In this implementation order is maintained is by original insertion.
* <p>
* This implementation improves on the JDK1.4 LinkedHashMap by adding the
* {@link org.apache.commons.collections.iterators.MapIterator MapIterator}
* {@link org.apache.commons.collections.MapIterator MapIterator}
* functionality, additional convenience methods and allowing
* bidirectional iteration. It also implements <code>OrderedMap</code>.
* <p>
@ -83,7 +83,7 @@ import java.util.Map;
* methods exposed.
*
* @since Commons Collections 3.0
* @version $Revision: 1.4 $ $Date: 2003/12/07 23:59:13 $
* @version $Revision: 1.5 $ $Date: 2003/12/28 17:58:54 $
*
* @author Stephen Colebourne
*/