You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@tomcat.apache.org by ma...@apache.org on 2019/09/09 10:26:45 UTC
[tomcat] branch 7.0.x updated: Fix Javadoc errors with Java 9
This is an automated email from the ASF dual-hosted git repository.
markt pushed a commit to branch 7.0.x
in repository https://gitbox.apache.org/repos/asf/tomcat.git
The following commit(s) were added to refs/heads/7.0.x by this push:
new 535bcea Fix Javadoc errors with Java 9
535bcea is described below
commit 535bceac6e01f71b6a0288252ebbd4fac6ef2a79
Author: Mark Thomas <ma...@apache.org>
AuthorDate: Mon Sep 9 11:26:39 2019 +0100
Fix Javadoc errors with Java 9
Hopefully the last of the errors. Still lot sof warnings.
---
java/org/apache/catalina/startup/Tomcat.java | 3 +--
.../org/apache/tomcat/jdbc/pool/DataSourceFactory.java | 13 ++++++-------
.../java/org/apache/tomcat/jdbc/pool/PooledConnection.java | 14 ++++++++------
3 files changed, 15 insertions(+), 15 deletions(-)
diff --git a/java/org/apache/catalina/startup/Tomcat.java b/java/org/apache/catalina/startup/Tomcat.java
index d638f8a..3dd0a23 100644
--- a/java/org/apache/catalina/startup/Tomcat.java
+++ b/java/org/apache/catalina/startup/Tomcat.java
@@ -690,11 +690,10 @@ public class Tomcat {
* @param contextPath The context mapping to use, "" for root context.
* @param docBase Base directory for the context, for static files.
* Must exist, relative to the server home
- * @param config Custom context configurator helper
+ * @param name Ignored. The contextPath will be used
* @return the deployed context
* @see #addWebapp(String, String)
*
- * @param name Ignored. The contextPath will be used
*
* @deprecated Use {@link #addWebapp(Host, String, String)}
*/
diff --git a/modules/jdbc-pool/src/main/java/org/apache/tomcat/jdbc/pool/DataSourceFactory.java b/modules/jdbc-pool/src/main/java/org/apache/tomcat/jdbc/pool/DataSourceFactory.java
index f60dd95..8e16bfd 100644
--- a/modules/jdbc-pool/src/main/java/org/apache/tomcat/jdbc/pool/DataSourceFactory.java
+++ b/modules/jdbc-pool/src/main/java/org/apache/tomcat/jdbc/pool/DataSourceFactory.java
@@ -53,7 +53,6 @@ import org.apache.juli.logging.LogFactory;
*</ol>
* @author Craig R. McClanahan
* @author Dirk Verbeeck
- * @author Filip Hanik
*/
public class DataSourceFactory implements ObjectFactory {
private static final Log log = LogFactory.getLog(DataSourceFactory.class);
@@ -543,6 +542,7 @@ public class DataSourceFactory implements ObjectFactory {
* given properties.
*
* @param properties the datasource configuration properties
+ * @return the datasource
* @throws Exception if an error occurs creating the data source
*/
public DataSource createDataSource(Properties properties) throws Exception {
@@ -571,14 +571,14 @@ public class DataSourceFactory implements ObjectFactory {
log.warn("dataSourceJNDI property is configured, but local JNDI context is null.");
}
} catch (NamingException e) {
- log.debug("The name \""+poolProperties.getDataSourceJNDI()+"\" can not be found in the local context.");
+ log.debug("The name \""+poolProperties.getDataSourceJNDI()+"\" cannot be found in the local context.");
}
if (jndiDS==null) {
try {
context = new InitialContext();
jndiDS = context.lookup(poolProperties.getDataSourceJNDI());
} catch (NamingException e) {
- log.warn("The name \""+poolProperties.getDataSourceJNDI()+"\" can not be found in the InitialContext.");
+ log.warn("The name \""+poolProperties.getDataSourceJNDI()+"\" cannot be found in the InitialContext.");
}
}
if (jndiDS!=null) {
@@ -587,10 +587,9 @@ public class DataSourceFactory implements ObjectFactory {
}
/**
- * <p>Parse properties from the string. Format of the string must be [propertyName=property;]*<p>
- * @param propText
- * @return Properties
- * @throws Exception
+ * Parse properties from the string. Format of the string must be [propertyName=property;]*.
+ * @param propText The properties string
+ * @return the properties
*/
protected static Properties getProperties(String propText) {
return PoolProperties.getProperties(propText,null);
diff --git a/modules/jdbc-pool/src/main/java/org/apache/tomcat/jdbc/pool/PooledConnection.java b/modules/jdbc-pool/src/main/java/org/apache/tomcat/jdbc/pool/PooledConnection.java
index ee5fa83..05f9025 100644
--- a/modules/jdbc-pool/src/main/java/org/apache/tomcat/jdbc/pool/PooledConnection.java
+++ b/modules/jdbc-pool/src/main/java/org/apache/tomcat/jdbc/pool/PooledConnection.java
@@ -31,7 +31,6 @@ import org.apache.tomcat.jdbc.pool.interceptor.ConnectionState;
/**
* Represents a pooled connection
* and holds a reference to the {@link java.sql.Connection} object
- * @author Filip Hanik
* @version 1.0
*/
public class PooledConnection {
@@ -362,9 +361,9 @@ public class PooledConnection {
}
/**
- * Returns true if the connection pool is configured
+ * Returns <code>true</code> if the connection pool is configured
* to do validation for a certain action.
- * @param action
+ * @param action The validation action
*/
private boolean doValidate(int action) {
if (action == PooledConnection.VALIDATE_BORROW &&
@@ -386,9 +385,12 @@ public class PooledConnection {
return false;
}
- /**Returns true if the object is still valid. if not
+ /**
+ * Returns <code>true</code> if the object is still valid. if not
* the pool will call the getExpiredAction() and follow up with one
* of the four expired methods
+ * @param validateAction The value
+ * @return <code>true</code> if the connection is valid
*/
public boolean validate(int validateAction) {
return validate(validateAction,null);
@@ -522,7 +524,7 @@ public class PooledConnection {
}
/**
- * This method is called if (Now - timeCheckedIn > getReleaseTime())
+ * This method is called if (Now - timeCheckedIn > getReleaseTime())
* This method disconnects the connection, logs an error in debug mode if it happens
* then sets the {@link #released} flag to false. Any attempts to connect this cached object again
* will fail per {@link #connect()}
@@ -600,7 +602,7 @@ public class PooledConnection {
/**
* Sets the pool configuration for this connection and connection pool.
* Object is shared with the {@link ConnectionPool}
- * @param poolProperties
+ * @param poolProperties The pool properties
*/
public void setPoolProperties(PoolConfiguration poolProperties) {
this.poolProperties = poolProperties;
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org