svn commit: r1330180 - in /commons/proper/pool/trunk/src/main/java/org/apache/commons/pool2/impl: DefaultEvictionPolicy.java EvictionTimer.java

[ma...@apache.org]

Author: markt
Date: Wed Apr 25 10:00:10 2012
New Revision: 1330180

URL: http://svn.apache.org/viewvc?rev=1330180&view=rev
Log:
Javadoc tweaks

Modified:
    commons/proper/pool/trunk/src/main/java/org/apache/commons/pool2/impl/DefaultEvictionPolicy.java
    commons/proper/pool/trunk/src/main/java/org/apache/commons/pool2/impl/EvictionTimer.java

Modified: commons/proper/pool/trunk/src/main/java/org/apache/commons/pool2/impl/DefaultEvictionPolicy.java
URL: http://svn.apache.org/viewvc/commons/proper/pool/trunk/src/main/java/org/apache/commons/pool2/impl/DefaultEvictionPolicy.java?rev=1330180&r1=1330179&r2=1330180&view=diff
==============================================================================
--- commons/proper/pool/trunk/src/main/java/org/apache/commons/pool2/impl/DefaultEvictionPolicy.java (original)
+++ commons/proper/pool/trunk/src/main/java/org/apache/commons/pool2/impl/DefaultEvictionPolicy.java Wed Apr 25 10:00:10 2012
@@ -20,11 +20,13 @@ package org.apache.commons.pool2.impl;
  * Objects will be evicted if the following conditions are met:
  * <ul>
  * <li>the object has been idle longer than
- *     {@link BaseObjectPoolConfig#getMinEvictableIdleTimeMillis()}</li>
+ *     {@link GenericObjectPool#getMinEvictableIdleTimeMillis()} /
+ *     {@link GenericKeyedObjectPool#getMinEvictableIdleTimeMillis()}</li>
  * <li>there are more than {@link GenericObjectPool#getMinIdle()} /
- *     (@link GenericKeyedObjectPoolConfig#getMinIdlePerKey()} idle objects in
+ *     {@link GenericKeyedObjectPoolConfig#getMinIdlePerKey()} idle objects in
  *     the pool and the object has been idle for longer than
- *     {@link BaseObjectPoolConfig#getSoftMinEvictableIdleTimeMillis()}
+ *     {@link GenericObjectPool#getSoftMinEvictableIdleTimeMillis()} /
+ *     {@link GenericKeyedObjectPool#getSoftMinEvictableIdleTimeMillis()}
  * </ul>
  */
 public class DefaultEvictionPolicy<T> implements EvictionPolicy<T> {

Modified: commons/proper/pool/trunk/src/main/java/org/apache/commons/pool2/impl/EvictionTimer.java
URL: http://svn.apache.org/viewvc/commons/proper/pool/trunk/src/main/java/org/apache/commons/pool2/impl/EvictionTimer.java?rev=1330180&r1=1330179&r2=1330180&view=diff
==============================================================================
--- commons/proper/pool/trunk/src/main/java/org/apache/commons/pool2/impl/EvictionTimer.java (original)
+++ commons/proper/pool/trunk/src/main/java/org/apache/commons/pool2/impl/EvictionTimer.java Wed Apr 25 10:00:10 2012
@@ -14,7 +14,6 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-
 package org.apache.commons.pool2.impl;
 
 import java.security.AccessController;
@@ -23,18 +22,15 @@ import java.util.Timer;
 import java.util.TimerTask;
 
 /**
- * <p>
  * Provides a shared idle object eviction timer for all pools. This class wraps
  * the standard {@link Timer} and keeps track of how many pools are using it.
- * If no pools are using the timer, it is canceled. This prevents a thread
+ * If no pools are using the timer, it is cancelled. This prevents a thread
  * being left running which, in application server environments, can lead to
  * memory leads and/or prevent applications from shutting down or reloading
  * cleanly.
- * </p>
  * <p>
  * This class has package scope to prevent its inclusion in the pool public API.
  * The class declaration below should *not* be changed to public.
- * </p>
  * <p>
  * This class is intended to be thread-safe.
  */