svn commit: r1334380 - /commons/proper/pool/trunk/src/main/java/org/apache/commons/pool2/impl/GenericKeyedObjectPool.java

[se...@apache.org]

Author: sebb
Date: Sat May  5 10:14:07 2012
New Revision: 1334380

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

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

Modified: commons/proper/pool/trunk/src/main/java/org/apache/commons/pool2/impl/GenericKeyedObjectPool.java
URL: http://svn.apache.org/viewvc/commons/proper/pool/trunk/src/main/java/org/apache/commons/pool2/impl/GenericKeyedObjectPool.java?rev=1334380&r1=1334379&r2=1334380&view=diff
==============================================================================
--- commons/proper/pool/trunk/src/main/java/org/apache/commons/pool2/impl/GenericKeyedObjectPool.java (original)
+++ commons/proper/pool/trunk/src/main/java/org/apache/commons/pool2/impl/GenericKeyedObjectPool.java Sat May  5 10:14:07 2012
@@ -77,6 +77,7 @@ public class GenericKeyedObjectPool<K,T>
     /**
      * Create a new <code>GenericKeyedObjectPool</code> using defaults from
      * {@link GenericKeyedObjectPoolConfig}.
+     * @param factory the factory to be used to create entries
      */
     public GenericKeyedObjectPool(KeyedPoolableObjectFactory<K,T> factory) {
         this(factory, new GenericKeyedObjectPoolConfig());
@@ -86,6 +87,7 @@ public class GenericKeyedObjectPool<K,T>
      * Create a new <code>GenericKeyedObjectPool</code> using a specific
      * configuration.
      *
+     * @param factory the factory to be used to create entries
      * @param config    The configuration to use for this pool instance. The
      *                  configuration is used by value. Subsequent changes to
      *                  the configuration object will not be reflected in the
@@ -262,6 +264,8 @@ public class GenericKeyedObjectPool<K,T>
     /**
      * Equivalent to <code>{@link #borrowObject(Object, long) borrowObject}(key,
      * {@link #getMaxWaitMillis()})</code>.
+     * <p>
+     * {@inheritDoc}
      */
     @Override
     public T borrowObject(K key) throws Exception {
@@ -612,14 +616,16 @@ public class GenericKeyedObjectPool<K,T>
 
 
     /**
-     * Returns the total number of instances currently borrowed from this pool
-     * but not yet returned.
+     * {@inheritDoc}
      */
     @Override
     public int getNumActive() {
         return numTotal.get() - getNumIdle();
     }
 
+    /**
+     * {@inheritDoc}
+     */
     @Override
     public int getNumIdle() {
         Iterator<ObjectDeque<T>> iter = poolMap.values().iterator();