svn commit: r965336 - in /commons/proper/pool/trunk/src/java/org/apache/commons/pool: BasePoolableObjectFactory.java impl/EvictionTimer.java

[psteitz]

Author: psteitz
Date: Mon Jul 19 00:58:33 2010
New Revision: 965336

URL: http://svn.apache.org/viewvc?rev=965336&view=rev
Log:
Improved javadoc.

Modified:
    
commons/proper/pool/trunk/src/java/org/apache/commons/pool/BasePoolableObjectFactory.java
    
commons/proper/pool/trunk/src/java/org/apache/commons/pool/impl/EvictionTimer.java

Modified: 
commons/proper/pool/trunk/src/java/org/apache/commons/pool/BasePoolableObjectFactory.java
URL: 
http://svn.apache.org/viewvc/commons/proper/pool/trunk/src/java/org/apache/commons/pool/BasePoolableObjectFactory.java?rev=965336&r1=965335&r2=965336&view=diff
==============================================================================
--- 
commons/proper/pool/trunk/src/java/org/apache/commons/pool/BasePoolableObjectFactory.java
 (original)
+++ 
commons/proper/pool/trunk/src/java/org/apache/commons/pool/BasePoolableObjectFactory.java
 Mon Jul 19 00:58:33 2010
@@ -30,28 +30,44 @@ package org.apache.commons.pool;
  * @since Pool 1.0
  */
 public abstract class BasePoolableObjectFactory implements 
PoolableObjectFactory {
-    public abstract Object makeObject()
-        throws Exception;
+    
+    /**
+     * {...@inheritdoc}
+     */
+    public abstract Object makeObject() throws Exception;
 
-    /** No-op. */
+    /**
+     *  No-op.
+     *  
+     *  @param obj ignored
+     */
     public void destroyObject(Object obj)
         throws Exception  {
     }
 
     /**
      * This implementation always returns <tt>true</tt>.
+     * 
+     * @param obj ignored
      * @return <tt>true</tt>
      */
     public boolean validateObject(Object obj) {
         return true;
     }
 
-    /** No-op. */
-    public void activateObject(Object obj)
-        throws Exception {
+    /**
+     *  No-op.
+     *  
+     *  @param obj ignored
+     */
+    public void activateObject(Object obj) throws Exception {
     }
 
-    /** No-op. */
+    /**
+     *  No-op.
+     *  
+     * @param obj ignored
+     */
     public void passivateObject(Object obj)
         throws Exception {
     }

Modified: 
commons/proper/pool/trunk/src/java/org/apache/commons/pool/impl/EvictionTimer.java
URL: 
http://svn.apache.org/viewvc/commons/proper/pool/trunk/src/java/org/apache/commons/pool/impl/EvictionTimer.java?rev=965336&r1=965335&r2=965336&view=diff
==============================================================================
--- 
commons/proper/pool/trunk/src/java/org/apache/commons/pool/impl/EvictionTimer.java
 (original)
+++ 
commons/proper/pool/trunk/src/java/org/apache/commons/pool/impl/EvictionTimer.java
 Mon Jul 19 00:58:33 2010
@@ -26,7 +26,7 @@ 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 cancelled. This prevents a thread
+ * If no pools are using the timer, it is canceled. 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.
@@ -89,21 +89,38 @@ class EvictionTimer {
         }
     }
     
+    /** 
+     * {...@link PrivilegedAction} used to get the ContextClassLoader
+     */
     private static class PrivilegedGetTccl implements PrivilegedAction {
 
+        /** 
+         * {...@inheritdoc}
+         */
         public Object run() {
             return Thread.currentThread().getContextClassLoader();
         }
     }
 
+    /** 
+     * {...@link PrivilegedAction} used to set the ContextClassLoader
+     */
     private static class PrivilegedSetTccl implements PrivilegedAction {
 
+        /** ClassLoader */
         private final ClassLoader cl;
 
+        /**
+         * Create a new PrivilegedSetTccl using the given classloader
+         * @param cl ClassLoader to use
+         */
         PrivilegedSetTccl(ClassLoader cl) {
             this.cl = cl;
         }
 
+        /** 
+         * {...@inheritdoc}
+         */
         public Object run() {
             Thread.currentThread().setContextClassLoader(cl);
             return null;