(commons-dbcp) branch master updated: Javadoc

[ggregory]

This is an automated email from the ASF dual-hosted git repository.

ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-dbcp.git


The following commit(s) were added to refs/heads/master by this push:
     new 13bb605a Javadoc
13bb605a is described below

commit 13bb605afd3b31750f0ed8dd1a1aa1a0e1776e6f
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Sun Jun 23 15:50:59 2024 -0400

    Javadoc
---
 .../commons/dbcp2/datasources/PerUserPoolDataSource.java      | 11 ++++-------
 .../commons/dbcp2/datasources/SharedPoolDataSource.java       | 11 ++++-------
 2 files changed, 8 insertions(+), 14 deletions(-)

diff --git 
a/src/main/java/org/apache/commons/dbcp2/datasources/PerUserPoolDataSource.java 
b/src/main/java/org/apache/commons/dbcp2/datasources/PerUserPoolDataSource.java
index 1b60c498..46dcf3ae 100644
--- 
a/src/main/java/org/apache/commons/dbcp2/datasources/PerUserPoolDataSource.java
+++ 
b/src/main/java/org/apache/commons/dbcp2/datasources/PerUserPoolDataSource.java
@@ -684,14 +684,11 @@ public class PerUserPoolDataSource extends 
InstanceKeyDataSource {
     }
 
     /**
-     * Supports Serialization interface.
+     * Deserializes an instance from an ObjectInputStream.
      *
-     * @param in
-     *            a {@link ObjectInputStream} value
-     * @throws IOException
-     *             if an error occurs
-     * @throws ClassNotFoundException
-     *             if an error occurs
+     * @param in The source ObjectInputStream.
+     * @throws IOException            Any of the usual Input/Output related 
exceptions.
+     * @throws ClassNotFoundException A class of a serialized object cannot be 
found.
      */
     @SuppressWarnings("resource")
     private void readObject(final ObjectInputStream in) throws IOException, 
ClassNotFoundException {
diff --git 
a/src/main/java/org/apache/commons/dbcp2/datasources/SharedPoolDataSource.java 
b/src/main/java/org/apache/commons/dbcp2/datasources/SharedPoolDataSource.java
index 31e7aeda..fd596d51 100644
--- 
a/src/main/java/org/apache/commons/dbcp2/datasources/SharedPoolDataSource.java
+++ 
b/src/main/java/org/apache/commons/dbcp2/datasources/SharedPoolDataSource.java
@@ -142,14 +142,11 @@ public class SharedPoolDataSource extends 
InstanceKeyDataSource {
     }
 
     /**
-     * Supports Serialization interface.
+     * Deserializes an instance from an ObjectInputStream.
      *
-     * @param in
-     *            a {@link ObjectInputStream} value
-     * @throws IOException
-     *             if an error occurs
-     * @throws ClassNotFoundException
-     *             if an error occurs
+     * @param in The source ObjectInputStream.
+     * @throws IOException            Any of the usual Input/Output related 
exceptions.
+     * @throws ClassNotFoundException A class of a serialized object cannot be 
found.
      */
     private void readObject(final ObjectInputStream in) throws IOException, 
ClassNotFoundException {
         in.defaultReadObject();