scolebourne 2003/12/28 17:04:44
Modified: collections/src/java/org/apache/commons/collections/map
CompositeMap.java
collections/src/test/org/apache/commons/collections/bag
AbstractTestSortedBag.java AbstractTestBag.java
collections/src/java/org/apache/commons/collections/list
NodeCachingLinkedList.java AbstractLinkedList.java
Log:
Improve documentation
Revision Changes Path
1.2 +3 -3
jakarta-commons/collections/src/java/org/apache/commons/collections/map/CompositeMap.java
Index: CompositeMap.java
===================================================================
RCS file:
/home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/map/CompositeMap.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- CompositeMap.java 14 Dec 2003 21:42:55 -0000 1.1
+++ CompositeMap.java 29 Dec 2003 01:04:43 -0000 1.2
@@ -250,7 +250,7 @@
/**
* Returns a set view of the mappings contained in this map. Each element
- * in the returned set is a [EMAIL PROTECTED] Map.Entry}. The set is backed by
the
+ * in the returned set is a <code>Map.Entry</code>. The set is backed by the
* map, so changes to the map are reflected in the set, and vice-versa.
* If the map is modified while an iteration over the set is in progress,
* the results of the iteration are undefined. The set supports element
1.2 +5 -4
jakarta-commons/collections/src/test/org/apache/commons/collections/bag/AbstractTestSortedBag.java
Index: AbstractTestSortedBag.java
===================================================================
RCS file:
/home/cvs/jakarta-commons/collections/src/test/org/apache/commons/collections/bag/AbstractTestSortedBag.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- AbstractTestSortedBag.java 16 Nov 2003 22:15:10 -0000 1.1
+++ AbstractTestSortedBag.java 29 Dec 2003 01:04:44 -0000 1.2
@@ -57,9 +57,10 @@
*/
package org.apache.commons.collections.bag;
-
/**
- * Abstract test class for [EMAIL PROTECTED] SortedBag} methods and contracts.
+ * Abstract test class for
+ * [EMAIL PROTECTED] org.apache.commons.collections.SortedBag SortedBag}
+ * methods and contracts.
*
* @since Commons Collections 3.0
* @version $Revision$ $Date$
1.6 +6 -6
jakarta-commons/collections/src/test/org/apache/commons/collections/bag/AbstractTestBag.java
Index: AbstractTestBag.java
===================================================================
RCS file:
/home/cvs/jakarta-commons/collections/src/test/org/apache/commons/collections/bag/AbstractTestBag.java,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- AbstractTestBag.java 24 Dec 2003 23:22:54 -0000 1.5
+++ AbstractTestBag.java 29 Dec 2003 01:04:44 -0000 1.6
@@ -69,14 +69,14 @@
import org.apache.commons.collections.Bag;
/**
- * Abstract test class for [EMAIL PROTECTED] Bag} methods and contracts.
+ * Abstract test class for [EMAIL PROTECTED] org.apache.commons.collections.Bag
Bag} methods and contracts.
* <p>
* To use, simply extend this class, and implement
* the [EMAIL PROTECTED] #makeBag} method.
* <p>
- * If your [EMAIL PROTECTED] Bag} fails one of these tests by design,
+ * If your bag fails one of these tests by design,
* you may still use this base set of cases. Simply override the
- * test case (method) your [EMAIL PROTECTED] Bag} fails.
+ * test case (method) your bag fails.
*
* @version $Revision$ $Date$
*
@@ -100,7 +100,7 @@
//-----------------------------------------------------------------------
/**
- * Return a new, empty [EMAIL PROTECTED] Bag} to used for testing.
+ * Return a new, empty bag to used for testing.
*
* @return the bag to be tested
*/
1.3 +4 -4
jakarta-commons/collections/src/java/org/apache/commons/collections/list/NodeCachingLinkedList.java
Index: NodeCachingLinkedList.java
===================================================================
RCS file:
/home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/list/NodeCachingLinkedList.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- NodeCachingLinkedList.java 24 Dec 2003 01:15:40 -0000 1.2
+++ NodeCachingLinkedList.java 29 Dec 2003 01:04:44 -0000 1.3
@@ -97,8 +97,8 @@
/**
* The first cached node, or <code>null</code> if no nodes are cached.
- * Cached nodes are stored in a singly-linked list with [EMAIL PROTECTED]
Node#next}
- * pointing to the next element.
+ * Cached nodes are stored in a singly-linked list with
+ * <code>next</code> pointing to the next element.
*/
protected transient Node firstCachedNode;
1.5 +6 -4
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.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- AbstractLinkedList.java 29 Dec 2003 00:38:08 -0000 1.4
+++ AbstractLinkedList.java 29 Dec 2003 01:04:44 -0000 1.5
@@ -470,7 +470,8 @@
* 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(AbstractLinkedList.Node,AbstractLinkedList.Node)}.
*
* @param node node to insert before
* @param value value of the newly added node
@@ -485,7 +486,8 @@
* 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(AbstractLinkedList.Node,AbstractLinkedList.Node)}.
*
* @param node node to insert after
* @param value value of the newly added node
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
