Correct Javadoc for ConnectionPool.suspect().

Based on a patch by Yahya Cahyadi. git-svn-id: https://svn.apache.org/repos/asf/tomcat/trunk@1758588 13f79535-47bb-0310-9956-ffa450edef68
qinggumeng · Aug 31, 2016 · b660817 · b660817
1 parent 560db93
commit b660817
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 3 deletions.
diff --git a/modules/jdbc-pool/src/main/java/org/apache/tomcat/jdbc/pool/ConnectionPool.java b/modules/jdbc-pool/src/main/java/org/apache/tomcat/jdbc/pool/ConnectionPool.java
@@ -557,9 +557,11 @@ protected void abandon(PooledConnection con) {
     }
 
     /**
-     * thread safe way to abandon a connection
-     * signals a connection to be abandoned.
-     * this will disconnect the connection, and log the stack trace if logAbanded=true
+     * Thread safe way to suspect a connection. Similar to
+     * {@link #abandon(PooledConnection)}, but instead of actually abandoning
+     * the connection, this will log a warning and set the suspect flag on the
+     * {@link PooledConnection} if logAbandoned=true
+     *
      * @param con PooledConnection
      */
     protected void suspect(PooledConnection con) {

diff --git a/webapps/docs/changelog.xml b/webapps/docs/changelog.xml
@@ -351,6 +351,10 @@
         Add log message of when returning the connection that has been marked
         suspect. (kfujino)
       </fix>
+      <fix>
+        Correct Javadoc for <code>ConnectionPool.suspect()</code>. Based on a
+        patch by Yahya Cahyadi. (markt)
+      </fix>
     </changelog>
   </subsection>
   <subsection name="Other">