scolebourne 2003/12/28 09:58:54
Modified: collections/src/java/org/apache/commons/collections/bag
TreeBag.java
collections/src/java/org/apache/commons/collections/map
HashedMap.java LinkedMap.java
collections/src/java/org/apache/commons/collections/buffer
BinaryHeap.java
collections/src/java/org/apache/commons/collections/list
AbstractLinkedList.java
Log:
Improve documentation
Revision Changes Path
1.5 +4 -4
jakarta-commons/collections/src/java/org/apache/commons/collections/bag/TreeBag.java
Index: TreeBag.java
===================================================================
RCS file:
/home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/bag/TreeBag.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- TreeBag.java 28 Dec 2003 16:36:48 -0000 1.4
+++ TreeBag.java 28 Dec 2003 17:58:53 -0000 1.5
@@ -110,8 +110,8 @@
}
/**
- * Constructs a [EMAIL PROTECTED] 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
*/
1.11 +3 -3
jakarta-commons/collections/src/java/org/apache/commons/collections/map/HashedMap.java
Index: HashedMap.java
===================================================================
RCS file:
/home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/map/HashedMap.java,v
retrieving revision 1.10
retrieving revision 1.11
diff -u -r1.10 -r1.11
--- HashedMap.java 28 Dec 2003 16:36:48 -0000 1.10
+++ HashedMap.java 28 Dec 2003 17:58:53 -0000 1.11
@@ -68,7 +68,7 @@
* to <code>HashMap</code>.
* <p>
* This implementation improves on the JDK1.4 HahMap by adding the
- * [EMAIL PROTECTED] org.apache.commons.collections.iterators.MapIterator
MapIterator}
+ * [EMAIL PROTECTED] org.apache.commons.collections.MapIterator MapIterator}
* functionality and many methods for subclassing.
* <p>
* @since Commons Collections 3.0
1.5 +3 -3
jakarta-commons/collections/src/java/org/apache/commons/collections/map/LinkedMap.java
Index: LinkedMap.java
===================================================================
RCS file:
/home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/map/LinkedMap.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- LinkedMap.java 7 Dec 2003 23:59:13 -0000 1.4
+++ LinkedMap.java 28 Dec 2003 17:58:54 -0000 1.5
@@ -68,7 +68,7 @@
* In this implementation order is maintained is by original insertion.
* <p>
* This implementation improves on the JDK1.4 LinkedHashMap by adding the
- * [EMAIL PROTECTED] org.apache.commons.collections.iterators.MapIterator
MapIterator}
+ * [EMAIL PROTECTED] org.apache.commons.collections.MapIterator MapIterator}
* functionality, additional convenience methods and allowing
* bidirectional iteration. It also implements <code>OrderedMap</code>.
* <p>
1.3 +6 -5
jakarta-commons/collections/src/java/org/apache/commons/collections/buffer/BinaryHeap.java
Index: BinaryHeap.java
===================================================================
RCS file:
/home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/buffer/BinaryHeap.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- BinaryHeap.java 28 Dec 2003 16:36:48 -0000 1.2
+++ BinaryHeap.java 28 Dec 2003 17:58:54 -0000 1.3
@@ -67,7 +67,8 @@
import org.apache.commons.collections.PriorityQueue;
/**
- * Binary heap implementation of [EMAIL PROTECTED] PriorityQueue} and [EMAIL
PROTECTED] 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 [EMAIL PROTECTED] Comparator}. The
@@ -83,8 +84,8 @@
* time. All other operations perform in linear time or worse.
* <p>
* Note that this implementation is not synchronized. Use
- * [EMAIL PROTECTED] BufferUtils#synchronizedBuffer(Buffer)} to provide
- * synchronized access to a <code>BinaryHeap</code>:
+ * [EMAIL PROTECTED]
org.apache.commons.collections.PriorityQueueUtils#synchronizedPriorityQueue(PriorityQueue)}
+ * to provide synchronized access to a <code>BinaryHeap</code>:
*
* <pre>
* Buffer heap = BufferUtils.synchronizedBuffer(new BinaryHeap());
1.3 +6 -6
jakarta-commons/collections/src/java/org/apache/commons/collections/list/AbstractLinkedList.java
Index: AbstractLinkedList.java
===================================================================
RCS file:
/home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/list/AbstractLinkedList.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- AbstractLinkedList.java 24 Dec 2003 01:15:40 -0000 1.2
+++ AbstractLinkedList.java 28 Dec 2003 17:58:54 -0000 1.3
@@ -470,7 +470,7 @@
* Creates a new node with the specified object as its
* <code>value</code> and inserts it before <code>node</code>.
* <p>
- * This implementation uses [EMAIL PROTECTED] #createNode(Object)} and [EMAIL
PROTECTED] #addNode(Node, Node)}.
+ * This implementation uses [EMAIL PROTECTED] #createNode(Object)} and [EMAIL
PROTECTED] #addNode(Node,Node)}.
*
* @param node node to insert before
* @param value value of the newly added node
@@ -485,7 +485,7 @@
* Creates a new node with the specified object as its
* <code>value</code> and inserts it after <code>node</code>.
* <p>
- * This implementation uses [EMAIL PROTECTED] #createNode(Object)} and [EMAIL
PROTECTED] #addNode(Node, Node)}.
+ * This implementation uses [EMAIL PROTECTED] #createNode(Object)} and [EMAIL
PROTECTED] #addNode(Node,Node)}.
*
* @param node node to insert after
* @param value value of the newly added node
@@ -685,12 +685,12 @@
/**
* The node that will be returned by [EMAIL PROTECTED] #next()}. If this is
equal
- * to [EMAIL PROTECTED] #marker} then there are no more values to return.
+ * to [EMAIL PROTECTED] AbstractLinkedList#header} then there are no more
values to return.
*/
protected Node next;
/**
- * The index of [EMAIL PROTECTED] #nextNode}.
+ * The index of [EMAIL PROTECTED] #next}.
*/
protected int nextIndex;
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
