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@131473 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Stephen Colebourne 2003-12-29 01:04:44 +00:00
parent 5244676eeb
commit b146eabd9a
5 changed files with 24 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
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.4 2003/12/29 00:38:08 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.5 2003/12/29 01:04:44 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.4 $ $Date: 2003/12/29 00:38:08 $
* @version $Revision: 1.5 $ $Date: 2003/12/29 01:04:44 $
*
* @author Rich Dougherty
* @author Phil Steitz
@ -470,7 +470,8 @@ public abstract class AbstractLinkedList implements List {
* Creates a new node with the specified object as its
* <code>value</code> and inserts it before <code>node</code>.
* <p>
* This implementation uses {@link #createNode(Object)} and {@link #addNode(Node,Node)}.
* This implementation uses {@link #createNode(Object)} and
* {@link #addNode(AbstractLinkedList.Node,AbstractLinkedList.Node)}.
*
* @param node node to insert before
* @param value value of the newly added node
@ -485,7 +486,8 @@ public abstract class AbstractLinkedList implements List {
* Creates a new node with the specified object as its
* <code>value</code> and inserts it after <code>node</code>.
* <p>
* This implementation uses {@link #createNode(Object)} and {@link #addNode(Node,Node)}.
* This implementation uses {@link #createNode(Object)} and
* {@link #addNode(AbstractLinkedList.Node,AbstractLinkedList.Node)}.
*
* @param node node to insert after
* @param value value of the newly added node

8
src/java/org/apache/commons/collections/list/NodeCachingLinkedList.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/NodeCachingLinkedList.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/NodeCachingLinkedList.java,v 1.3 2003/12/29 01:04:44 scolebourne Exp $
* ====================================================================
*
* The Apache Software License, Version 1.1
@ -78,7 +78,7 @@ import java.util.Collection;
* <b>Note that this implementation is not synchronized.</b>
*
* @since Commons Collections 3.0
* @version $Revision: 1.2 $ $Date: 2003/12/24 01:15:40 $
* @version $Revision: 1.3 $ $Date: 2003/12/29 01:04:44 $
*
* @author Jeff Varszegi
* @author Rich Dougherty
@ -97,8 +97,8 @@ public class NodeCachingLinkedList extends AbstractLinkedList implements Seriali
/**
* The first cached node, or <code>null</code> if no nodes are cached.
* Cached nodes are stored in a singly-linked list with {@link 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;

6
src/java/org/apache/commons/collections/map/CompositeMap.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/CompositeMap.java,v 1.1 2003/12/14 21:42:55 psteitz Exp $
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/map/CompositeMap.java,v 1.2 2003/12/29 01:04:43 scolebourne Exp $
* ====================================================================
*
* The Apache Software License, Version 1.1
@ -74,7 +74,7 @@ import org.apache.commons.collections.set.CompositeSet;
* strategy is provided then add and remove are unsupported.
*
* @since Commons Collections 3.0
* @version $Revision: 1.1 $ $Date: 2003/12/14 21:42:55 $
* @version $Revision: 1.2 $ $Date: 2003/12/29 01:04:43 $
*
* @author Brian McCallister
*/
@ -250,7 +250,7 @@ public class CompositeMap implements Map {
/**
* Returns a set view of the mappings contained in this map. Each element
* in the returned set is a {@link 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

12
src/test/org/apache/commons/collections/bag/AbstractTestBag.java
View File

@ -1,5 +1,5 @@
/*
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/test/org/apache/commons/collections/bag/AbstractTestBag.java,v 1.5 2003/12/24 23:22:54 scolebourne Exp $
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/test/org/apache/commons/collections/bag/AbstractTestBag.java,v 1.6 2003/12/29 01:04:44 scolebourne Exp $
* ====================================================================
*
* The Apache Software License, Version 1.1
@ -69,16 +69,16 @@ import org.apache.commons.collections.AbstractTestObject;
import org.apache.commons.collections.Bag;
/**
* Abstract test class for {@link Bag} methods and contracts.
* Abstract test class for {@link org.apache.commons.collections.Bag Bag} methods and contracts.
* <p>
* To use, simply extend this class, and implement
* the {@link #makeBag} method.
* <p>
* If your {@link 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 {@link Bag} fails.
* test case (method) your bag fails.
*
* @version $Revision: 1.5 $ $Date: 2003/12/24 23:22:54 $
* @version $Revision: 1.6 $ $Date: 2003/12/29 01:04:44 $
*
* @author Chuck Burdick
* @author Stephen Colebourne
@ -100,7 +100,7 @@ public abstract class AbstractTestBag extends AbstractTestObject {
//-----------------------------------------------------------------------
/**
* Return a new, empty {@link Bag} to used for testing.
* Return a new, empty bag to used for testing.
*
* @return the bag to be tested
*/

9
src/test/org/apache/commons/collections/bag/AbstractTestSortedBag.java
View File

@ -1,5 +1,5 @@
/*
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/test/org/apache/commons/collections/bag/AbstractTestSortedBag.java,v 1.1 2003/11/16 22:15:10 scolebourne Exp $
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/test/org/apache/commons/collections/bag/AbstractTestSortedBag.java,v 1.2 2003/12/29 01:04:44 scolebourne Exp $
* ====================================================================
*
* The Apache Software License, Version 1.1
@ -57,12 +57,13 @@
*/
package org.apache.commons.collections.bag;
/**
* Abstract test class for {@link SortedBag} methods and contracts.
* Abstract test class for
* {@link org.apache.commons.collections.SortedBag SortedBag}
* methods and contracts.
*
* @since Commons Collections 3.0
* @version $Revision: 1.1 $ $Date: 2003/11/16 22:15:10 $
* @version $Revision: 1.2 $ $Date: 2003/12/29 01:04:44 $
*
* @author Stephen Colebourne
*/