You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by gg...@apache.org on 2018/06/09 15:37:58 UTC

commons-pool git commit: Javadoc clarification.

Repository: commons-pool
Updated Branches:
  refs/heads/master ddf92b658 -> 2530447d5


Javadoc clarification.

Project: http://git-wip-us.apache.org/repos/asf/commons-pool/repo
Commit: http://git-wip-us.apache.org/repos/asf/commons-pool/commit/2530447d
Tree: http://git-wip-us.apache.org/repos/asf/commons-pool/tree/2530447d
Diff: http://git-wip-us.apache.org/repos/asf/commons-pool/diff/2530447d

Branch: refs/heads/master
Commit: 2530447d584831c0e8a41aad11153e43edb8290b
Parents: ddf92b6
Author: Gary Gregory <ga...@gmail.com>
Authored: Sat Jun 9 09:37:55 2018 -0600
Committer: Gary Gregory <ga...@gmail.com>
Committed: Sat Jun 9 09:37:55 2018 -0600

----------------------------------------------------------------------
 .../org/apache/commons/pool2/impl/BaseGenericObjectPool.java | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/commons-pool/blob/2530447d/src/main/java/org/apache/commons/pool2/impl/BaseGenericObjectPool.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/pool2/impl/BaseGenericObjectPool.java b/src/main/java/org/apache/commons/pool2/impl/BaseGenericObjectPool.java
index c4837c0..372cf87 100644
--- a/src/main/java/org/apache/commons/pool2/impl/BaseGenericObjectPool.java
+++ b/src/main/java/org/apache/commons/pool2/impl/BaseGenericObjectPool.java
@@ -450,9 +450,11 @@ public abstract class BaseGenericObjectPool<T> extends BaseObject {
     }
 
     /**
-     * Sets the number of milliseconds to sleep between runs of the idle
-     * object evictor thread. When non-positive, no idle object evictor thread
-     * will be run.
+     * Sets the number of milliseconds to sleep between runs of the idle object evictor thread.
+     * <ul>
+     * <li>When positive, the idle object evictor thread starts.</li>
+     * <li>When non-positive, no idle object evictor thread runs.</li>
+     * </ul>
      *
      * @param timeBetweenEvictionRunsMillis
      *            number of milliseconds to sleep between evictor runs