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

[psteitz]

Author: psteitz
Date: Mon May 25 19:34:55 2009
New Revision: 778480

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

Modified:
    
commons/proper/pool/trunk/src/java/org/apache/commons/pool/KeyedObjectPool.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/KeyedObjectPool.java
URL: 
http://svn.apache.org/viewvc/commons/proper/pool/trunk/src/java/org/apache/commons/pool/KeyedObjectPool.java?rev=778480&r1=778479&r2=778480&view=diff
==============================================================================
--- 
commons/proper/pool/trunk/src/java/org/apache/commons/pool/KeyedObjectPool.java 
(original)
+++ 
commons/proper/pool/trunk/src/java/org/apache/commons/pool/KeyedObjectPool.java 
Mon May 25 19:34:55 2009
@@ -103,9 +103,7 @@
      *
      * @param key the key used to obtain the object
      * @param obj a {...@link #borrowObject borrowed} instance to be returned.
-     * @throws Exception <b>deprecated</b>: as of Pool 2.0 pool 
implementations should swallow
-     * exceptions that occur when a poolable object is returned. For future 
source compatability
-     * implementations of this method should not even declare that they throw 
any exception.
+     * @throws Exception 
      */
     void returnObject(Object key, Object obj) throws Exception;
 
@@ -124,9 +122,7 @@
      *
      * @param key the key used to obtain the object
      * @param obj a {...@link #borrowObject borrowed} instance to be returned.
-     * @throws Exception <b>deprecated</b>: as of Pool 2.0 pool 
implementations should swallow
-     * exceptions that occur when a poolable object is returned. For future 
source compatability
-     * implementations of this method should not even declare that they throw 
any exception.
+     * @throws Exception 
      */
     void invalidateObject(Object key, Object obj) throws Exception;
 
@@ -215,7 +211,7 @@
      * this method on a pool will cause them to throw an {...@link 
IllegalStateException}.
      * </p>
      *
-     * @throws Exception <strong>deprecated</strong>: implementations should 
silently fail if not all resources can be freed.
+     * @throws Exception
      */
     void close() 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=778480&r1=778479&r2=778480&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 May 25 19:34:55 2009
@@ -35,9 +35,14 @@
  * </p>
  */
 class EvictionTimer {
+    
+    /** Timer instance */
     private static Timer _timer;
+    
+    /** Static usage count tracker */
     private static int _usageCount;
 
+    /** Prevent instantiation */
     private EvictionTimer() {
         // Hide the default constuctor
     }