From 7f0c6e905a5e9b9b060dd7a0d135dfc52d2185b1 Mon Sep 17 00:00:00 2001 From: Thomas Neidhart Date: Sat, 23 Jun 2012 17:02:29 +0000 Subject: [PATCH] Remove again unneeded closing p tags to keep consistency. git-svn-id: https://svn.apache.org/repos/asf/commons/proper/collections/trunk@1353163 13f79535-47bb-0310-9956-ffa450edef68 --- .../org/apache/commons/collections/Bag.java | 26 +++++++++---------- .../apache/commons/collections/Buffer.java | 6 ++--- .../apache/commons/collections/Closure.java | 4 +-- .../apache/commons/collections/Factory.java | 4 +-- .../apache/commons/collections/MultiMap.java | 8 +++--- 5 files changed, 24 insertions(+), 24 deletions(-) diff --git a/src/main/java/org/apache/commons/collections/Bag.java b/src/main/java/org/apache/commons/collections/Bag.java index caf8e63c4..896c80e93 100644 --- a/src/main/java/org/apache/commons/collections/Bag.java +++ b/src/main/java/org/apache/commons/collections/Bag.java @@ -26,17 +26,17 @@ import java.util.Set; *

* Suppose you have a Bag that contains {a, a, b, c}. * Calling {@link #getCount(Object)} on a would return 2, while - * calling {@link #uniqueSet()} would return {a, b, c}.

+ * calling {@link #uniqueSet()} would return {a, b, c}. *

* NOTE: This interface violates the {@link Collection} contract. * The behavior specified in many of these methods is not the same * as the behavior specified by Collection. * The noncompliant methods are clearly marked with "(Violation)". - * Exercise caution when using a bag as a Collection.

+ * Exercise caution when using a bag as a Collection. *

* This violation resulted from the original specification of this interface. * In an ideal world, the interface would be changed to fix the problems, however - * it has been decided to maintain backwards compatibility instead.

+ * it has been decided to maintain backwards compatibility instead. * * @param the type held in the bag * @since Commons Collections 2.0 @@ -63,12 +63,12 @@ public interface Bag extends Collection { *

* If the object is already in the {@link #uniqueSet()} then increment its * count as reported by {@link #getCount(Object)}. Otherwise add it to the - * {@link #uniqueSet()} and report its count as 1.

+ * {@link #uniqueSet()} and report its count as 1. *

* Since this method always increases the size of the bag, * according to the {@link Collection#add(Object)} contract, it * should always return true. Since it sometimes returns - * false, this method violates the contract.

+ * false, this method violates the contract. * * @param object the object to add * @return true if the object was not already in the uniqueSet @@ -80,7 +80,7 @@ public interface Bag extends Collection { *

* If the object is already in the {@link #uniqueSet()} then increment its * count as reported by {@link #getCount(Object)}. Otherwise add it to the - * {@link #uniqueSet()} and report its count as nCopies.

+ * {@link #uniqueSet()} and report its count as nCopies. * * @param object the object to add * @param nCopies the number of copies to add @@ -92,11 +92,11 @@ public interface Bag extends Collection { * (Violation) * Removes all occurrences of the given object from the bag. *

- * This will also remove the object from the {@link #uniqueSet()}.

+ * This will also remove the object from the {@link #uniqueSet()}. *

* According to the {@link Collection#remove(Object)} method, * this method should only remove the first occurrence of the - * given object, not all occurrences.

+ * given object, not all occurrences. * * @param object the object to remove * @return true if this call changed the collection @@ -107,7 +107,7 @@ public interface Bag extends Collection { * Removes nCopies copies of the specified object from the Bag. *

* If the number of copies to remove is greater than the actual number of - * copies in the Bag, no error is thrown.

+ * copies in the Bag, no error is thrown. * * @param object the object to remove * @param nCopies the number of copies to remove @@ -118,7 +118,7 @@ public interface Bag extends Collection { /** * Returns a {@link Set} of unique elements in the Bag. *

- * Uniqueness constraints are the same as those in {@link java.util.Set}.

+ * Uniqueness constraints are the same as those in {@link java.util.Set}. * * @return the Set of unique Bag elements */ @@ -142,7 +142,7 @@ public interface Bag extends Collection { * The {@link Collection#containsAll(Collection)} method specifies * that cardinality should not be respected; this method should * return true if the bag contains at least one of every object contained - * in the given collection.

+ * in the given collection. * * @param coll the collection to check against * @return true if the Bag contains all the collection @@ -160,7 +160,7 @@ public interface Bag extends Collection { *

The {@link Collection#removeAll(Collection)} method specifies * that cardinality should not be respected; this method should * remove all occurrences of every object contained in the - * given collection.

+ * given collection. * * @param coll the collection to remove * @return true if this call changed the collection @@ -181,7 +181,7 @@ public interface Bag extends Collection { *

The {@link Collection#retainAll(Collection)} method specifies * that cardinality should not be respected; this method should * keep all occurrences of every object contained in the - * given collection.

+ * given collection. * * @param coll the collection to retain * @return true if this call changed the collection diff --git a/src/main/java/org/apache/commons/collections/Buffer.java b/src/main/java/org/apache/commons/collections/Buffer.java index a7116e8a3..cb398c4ce 100644 --- a/src/main/java/org/apache/commons/collections/Buffer.java +++ b/src/main/java/org/apache/commons/collections/Buffer.java @@ -23,17 +23,17 @@ import java.util.Collection; *

* The removal order can be based on insertion order (eg, a FIFO queue or a * LIFO stack), on access order (eg, an LRU cache), on some arbitrary comparator - * (eg, a priority queue) or on any other well-defined ordering.

+ * (eg, a priority queue) or on any other well-defined ordering. *

* Note that the removal order is not necessarily the same as the iteration * order. A Buffer implementation may have equivalent removal - * and iteration orders, but this is not required.

+ * and iteration orders, but this is not required. *

* This interface does not specify any behavior for * {@link Object#equals(Object)} and {@link Object#hashCode} methods. It * is therefore possible for a Buffer implementation to also * also implement {@link java.util.List}, {@link java.util.Set} or - * {@link Bag}.

+ * {@link Bag}. * * @param the type of the elements in the buffer * @since Commons Collections 2.1 diff --git a/src/main/java/org/apache/commons/collections/Closure.java b/src/main/java/org/apache/commons/collections/Closure.java index 03b34aa4f..e3d7c47f7 100644 --- a/src/main/java/org/apache/commons/collections/Closure.java +++ b/src/main/java/org/apache/commons/collections/Closure.java @@ -20,10 +20,10 @@ package org.apache.commons.collections; * Defines a functor interface implemented by classes that do something. *

* A Closure represents a block of code which is executed from - * inside some block, function or iteration. It operates an input object.

+ * inside some block, function or iteration. It operates an input object. *

* Standard implementations of common closures are provided by - * {@link ClosureUtils}. These include method invocation and for/while loops.

+ * {@link ClosureUtils}. These include method invocation and for/while loops. * * @param the type that the closure acts on * @since Commons Collections 1.0 diff --git a/src/main/java/org/apache/commons/collections/Factory.java b/src/main/java/org/apache/commons/collections/Factory.java index 9a1ef2b2e..d97cdd562 100644 --- a/src/main/java/org/apache/commons/collections/Factory.java +++ b/src/main/java/org/apache/commons/collections/Factory.java @@ -20,11 +20,11 @@ package org.apache.commons.collections; * Defines a functor interface implemented by classes that create objects. *

* A Factory creates an object without using an input parameter. - * If an input parameter is required, then {@link Transformer} is more appropriate.

+ * If an input parameter is required, then {@link Transformer} is more appropriate. *

* Standard implementations of common factories are provided by * {@link FactoryUtils}. These include factories that return a constant, - * a copy of a prototype or a new instance.

+ * a copy of a prototype or a new instance. * * @param the type that the factory creates * diff --git a/src/main/java/org/apache/commons/collections/MultiMap.java b/src/main/java/org/apache/commons/collections/MultiMap.java index f3f63602c..47a7dfc63 100644 --- a/src/main/java/org/apache/commons/collections/MultiMap.java +++ b/src/main/java/org/apache/commons/collections/MultiMap.java @@ -23,7 +23,7 @@ import java.util.Collection; *

* A MultiMap is a Map with slightly different semantics. * Putting a value into the map will add the value to a Collection at that key. - * Getting a value will return a Collection, holding all the values put to that key.

+ * Getting a value will return a Collection, holding all the values put to that key. *

* For example: * 

@@ -31,13 +31,13 @@ import java.util.Collection;
  * mhm.put(key, "A");
  * mhm.put(key, "B");
  * mhm.put(key, "C");
- * Collection coll = (Collection) mhm.get(key);

+ * Collection coll = (Collection) mhm.get(key); *

- * coll will be a collection containing "A", "B", "C".

+ * coll will be a collection containing "A", "B", "C". *

* NOTE: Additional methods were added to this interface in Commons Collections 3.1. * These were added solely for documentation purposes and do not change the interface - * as they were defined in the superinterface Map anyway.

+ * as they were defined in the superinterface Map anyway. * * @since Commons Collections 2.0 * @version $Revision$