dirkv 2003/08/22 09:59:11 Modified: dbcp project.properties dbcp/src/java/org/apache/commons/dbcp PoolableConnectionFactory.java PoolingConnection.java package.html dbcp/src/java/org/apache/commons/dbcp/cpdsadapter DriverAdapterCPDS.java Log: fix javadoc warnings Revision Changes Path 1.3 +1 -1 jakarta-commons/dbcp/project.properties Index: project.properties =================================================================== RCS file: /home/cvs/jakarta-commons/dbcp/project.properties,v retrieving revision 1.2 retrieving revision 1.3 diff -u -r1.2 -r1.3 --- project.properties 22 Aug 2003 15:40:20 -0000 1.2 +++ project.properties 22 Aug 2003 16:59:11 -0000 1.3 @@ -1,7 +1,7 @@ maven.checkstyle.properties = checkstyle.xml maven.javadoc.author=false -maven.javadoc.links=http://java.sun.com/products/jdk/1.4/docs/api +maven.javadoc.links=http://java.sun.com/products/jdk/1.4/docs/api,http://jakarta.apache.org/commons/pool/apidocs maven.xdoc.date=left 1.10 +9 -9 jakarta-commons/dbcp/src/java/org/apache/commons/dbcp/PoolableConnectionFactory.java Index: PoolableConnectionFactory.java =================================================================== RCS file: /home/cvs/jakarta-commons/dbcp/src/java/org/apache/commons/dbcp/PoolableConnectionFactory.java,v retrieving revision 1.9 retrieving revision 1.10 diff -u -r1.9 -r1.10 --- PoolableConnectionFactory.java 22 Aug 2003 16:08:31 -0000 1.9 +++ PoolableConnectionFactory.java 22 Aug 2003 16:59:11 -0000 1.10 @@ -81,7 +81,7 @@ * Create a new <tt>PoolableConnectionFactory</tt>. * @param connFactory the [EMAIL PROTECTED] ConnectionFactory} from which to obtain base [EMAIL PROTECTED] Connection}s * @param pool the [EMAIL PROTECTED] ObjectPool} in which to pool those [EMAIL PROTECTED] Connection}s - * @param stmtPoolFactory the [EMAIL PROTECTED] KeyedObjectPoolFactory} to use to create [EMAIL PROTECTED] KeyedObjectPool}s for pooling [EMAIL PROTECTED] PreparedStatement}s, or <tt>null</tt> to disable [EMAIL PROTECTED] PreparedStatement} pooling + * @param stmtPoolFactory the [EMAIL PROTECTED] KeyedObjectPoolFactory} to use to create [EMAIL PROTECTED] KeyedObjectPool}s for pooling [EMAIL PROTECTED] java.sql.PreparedStatement}s, or <tt>null</tt> to disable [EMAIL PROTECTED] java.sql.PreparedStatement} pooling * @param validationQuery a query to use to [EMAIL PROTECTED] #validateObject validate} [EMAIL PROTECTED] Connection}s. Should return at least one row. May be <tt>null</tt> * @param defaultReadOnly the default "read only" setting for borrowed [EMAIL PROTECTED] Connection}s * @param defaultAutoCommit the default "auto commit" setting for returned [EMAIL PROTECTED] Connection}s @@ -100,7 +100,7 @@ * Create a new <tt>PoolableConnectionFactory</tt>. * @param connFactory the [EMAIL PROTECTED] ConnectionFactory} from which to obtain base [EMAIL PROTECTED] Connection}s * @param pool the [EMAIL PROTECTED] ObjectPool} in which to pool those [EMAIL PROTECTED] Connection}s - * @param stmtPoolFactory the [EMAIL PROTECTED] KeyedObjectPoolFactory} to use to create [EMAIL PROTECTED] KeyedObjectPool}s for pooling [EMAIL PROTECTED] PreparedStatement}s, or <tt>null</tt> to disable [EMAIL PROTECTED] PreparedStatement} pooling + * @param stmtPoolFactory the [EMAIL PROTECTED] KeyedObjectPoolFactory} to use to create [EMAIL PROTECTED] KeyedObjectPool}s for pooling [EMAIL PROTECTED] java.sql.PreparedStatement}s, or <tt>null</tt> to disable [EMAIL PROTECTED] java.sql.PreparedStatement} pooling * @param validationQuery a query to use to [EMAIL PROTECTED] #validateObject validate} [EMAIL PROTECTED] Connection}s. Should return at least one row. May be <tt>null</tt> * @param defaultReadOnly the default "read only" setting for borrowed [EMAIL PROTECTED] Connection}s * @param defaultAutoCommit the default "auto commit" setting for returned [EMAIL PROTECTED] Connection}s @@ -165,9 +165,9 @@ /** * Sets the [EMAIL PROTECTED] KeyedObjectPoolFactory} I use to create [EMAIL PROTECTED] KeyedObjectPool}s - * for pooling [EMAIL PROTECTED] PreparedStatement}s. - * Set to <tt>null</tt> to disable [EMAIL PROTECTED] PreparedStatement} pooling. - * @param stmtPoolFactory the [EMAIL PROTECTED] KeyedObjectPoolFactory} to use to create [EMAIL PROTECTED] KeyedObjectPool}s for pooling [EMAIL PROTECTED] PreparedStatement}s + * for pooling [EMAIL PROTECTED] java.sql.PreparedStatement}s. + * Set to <tt>null</tt> to disable [EMAIL PROTECTED] java.sql.PreparedStatement} pooling. + * @param stmtPoolFactory the [EMAIL PROTECTED] KeyedObjectPoolFactory} to use to create [EMAIL PROTECTED] KeyedObjectPool}s for pooling [EMAIL PROTECTED] java.sql.PreparedStatement}s */ synchronized public void setStatementPoolFactory(KeyedObjectPoolFactory stmtPoolFactory) { _stmtPoolFactory = stmtPoolFactory; 1.8 +5 -5 jakarta-commons/dbcp/src/java/org/apache/commons/dbcp/PoolingConnection.java Index: PoolingConnection.java =================================================================== RCS file: /home/cvs/jakarta-commons/dbcp/src/java/org/apache/commons/dbcp/PoolingConnection.java,v retrieving revision 1.7 retrieving revision 1.8 diff -u -r1.7 -r1.8 --- PoolingConnection.java 22 Aug 2003 16:08:31 -0000 1.7 +++ PoolingConnection.java 22 Aug 2003 16:59:11 -0000 1.8 @@ -148,14 +148,14 @@ } /** - * Create a [EMAIL PROTECTED] PoolingConnection.PStmtKey} for the given arguments. + * Create a PStmtKey for the given arguments. */ protected Object createKey(String sql, int resultSetType, int resultSetConcurrency) { return new PStmtKey(normalizeSQL(sql),resultSetType,resultSetConcurrency); } /** - * Create a [EMAIL PROTECTED] PoolingConnection.PStmtKey} for the given arguments. + * Create a PStmtKey for the given arguments. */ protected Object createKey(String sql) { return new PStmtKey(normalizeSQL(sql)); 1.2 +4 -4 jakarta-commons/dbcp/src/java/org/apache/commons/dbcp/package.html Index: package.html =================================================================== RCS file: /home/cvs/jakarta-commons/dbcp/src/java/org/apache/commons/dbcp/package.html,v retrieving revision 1.1 retrieving revision 1.2 diff -u -r1.1 -r1.2 --- package.html 14 Apr 2001 17:15:48 -0000 1.1 +++ package.html 22 Aug 2003 16:59:11 -0000 1.2 @@ -5,7 +5,7 @@ </head> <body> <p> - Database Connection Pool API + Database Connection Pool API. </p> <b>Overview in Dialog Form</b> @@ -81,7 +81,7 @@ the actual database [EMAIL PROTECTED] java.sql.Connection}s will be obtained. </li> <li> - An empty and factory-less [EMAIL PROTECTED] org.apache.commons.pool.Object} + An empty and factory-less [EMAIL PROTECTED] org.apache.commons.pool.ObjectPool} in which the [EMAIL PROTECTED] java.sql.Connection}s will be stored. <br> When you pass an [EMAIL PROTECTED] org.apache.commons.pool.ObjectPool} into the @@ -121,7 +121,7 @@ </p><p> A: If you're using the [EMAIL PROTECTED] org.apache.commons.dbcp.PoolingDriver}, you don't need to do this configuration in code. Instead, you can provide - a [EMAIL PROTECTED] org.apache.commons.jocl JOCL document} that describes the connection pool, + a JOCL document that describes the connection pool, and let the [EMAIL PROTECTED] org.apache.commons.dbcp.PoolingDriver} discover it at runtime. </p><p> 1.5 +6 -6 jakarta-commons/dbcp/src/java/org/apache/commons/dbcp/cpdsadapter/DriverAdapterCPDS.java Index: DriverAdapterCPDS.java =================================================================== RCS file: /home/cvs/jakarta-commons/dbcp/src/java/org/apache/commons/dbcp/cpdsadapter/DriverAdapterCPDS.java,v retrieving revision 1.4 retrieving revision 1.5 diff -u -r1.4 -r1.5 --- DriverAdapterCPDS.java 22 Aug 2003 16:08:32 -0000 1.4 +++ DriverAdapterCPDS.java 22 Aug 2003 16:59:11 -0000 1.5 @@ -88,7 +88,7 @@ * <code>ConnectionPoolDataSource</code>s are not used within general * applications. They are used by <code>DataSource</code> implementations * that pool <code>Connection</code>s, such as - * [EMAIL PROTECTED] org.apache.commons.dbcp.jdbc2pool.Jdbc2PoolDataSource}. A J2EE + * [EMAIL PROTECTED] org.apache.commons.dbcp.datasources.SharedPoolDataSource}. A J2EE * container will normally provide some method of initializing the * <code>ConnectionPoolDataSource</code> whose attributes are presented * as bean getters/setters and then deploying it via JNDI. It is then @@ -119,7 +119,7 @@ * <p> * The <a href="package-summary.html">package documentation</a> contains an * example using catalina and JNDI. The <a - * href="../datasources/package-summary.html">jdbc2pool package documentation</a> + * href="../datasources/package-summary.html">datasources package documentation</a> * shows how to use <code>DriverAdapterCPDS</code> as a source for * <code>Jdbc2PoolDataSource</code> without the use of JNDI. * </p>
--------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]