Author: markt Date: Mon Jan 2 11:31:13 2012 New Revision: 1226394 URL: http://svn.apache.org/viewvc?rev=1226394&view=rev Log: Fix Javadoc warnings
Modified: tomcat/trunk/build.xml tomcat/trunk/java/org/apache/naming/resources/VirtualDirContext.java tomcat/trunk/java/org/apache/tomcat/util/net/NioChannel.java tomcat/trunk/java/org/apache/tomcat/util/net/SecureNioChannel.java tomcat/trunk/modules/jdbc-pool/src/main/java/org/apache/tomcat/jdbc/pool/ConnectionPool.java tomcat/trunk/modules/jdbc-pool/src/main/java/org/apache/tomcat/jdbc/pool/PoolConfiguration.java Modified: tomcat/trunk/build.xml URL: http://svn.apache.org/viewvc/tomcat/trunk/build.xml?rev=1226394&r1=1226393&r2=1226394&view=diff ============================================================================== --- tomcat/trunk/build.xml (original) +++ tomcat/trunk/build.xml Mon Jan 2 11:31:13 2012 @@ -1578,9 +1578,9 @@ Apache Tomcat ${version} native binaries <link href="../servletapi"/> <link href="../jspapi"/> <link href="../elapi"/> - <link href="http://download.oracle.com/javase/6/docs/api/"/> + <link href="http://docs.oracle.com/javase/6/docs/api/"/> <link href="http://commons.apache.org/io/api-release/"/> - <link href="http://download-llnw.oracle.com/javaee/6/api/"/> + <link href="http://docs.oracle.com/javaee/6/api/"/> <sourcepath> <path location="${tomcat.dist}/src/java"/> <!--jdbc-pool src files for javadoc--> Modified: tomcat/trunk/java/org/apache/naming/resources/VirtualDirContext.java URL: http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/naming/resources/VirtualDirContext.java?rev=1226394&r1=1226393&r2=1226394&view=diff ============================================================================== --- tomcat/trunk/java/org/apache/naming/resources/VirtualDirContext.java (original) +++ tomcat/trunk/java/org/apache/naming/resources/VirtualDirContext.java Mon Jan 2 11:31:13 2012 @@ -34,7 +34,8 @@ import org.apache.naming.NamingEntry; * Extended FileDirContext implementation that allows to expose multiple * directories of the filesystem under a single webapp, a feature mainly used * for development with IDEs. - * This should be used in conjunction with {@link VirtualWebappLoader}. + * This should be used in conjunction with + * {@link org.apache.catalina.loader.VirtualWebappLoader}. * * Sample context xml configuration: * Modified: tomcat/trunk/java/org/apache/tomcat/util/net/NioChannel.java URL: http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/tomcat/util/net/NioChannel.java?rev=1226394&r1=1226393&r2=1226394&view=diff ============================================================================== --- tomcat/trunk/java/org/apache/tomcat/util/net/NioChannel.java (original) +++ tomcat/trunk/java/org/apache/tomcat/util/net/NioChannel.java Mon Jan 2 11:31:13 2012 @@ -79,13 +79,14 @@ public class NioChannel implements ByteC * @param s Unused. May be used when overridden * @param timeout Unused. May be used when overridden * @param lastWrite - * @return + * @return Always returns <code>true</code> since there is no network buffer + * in the regular channel * @throws IOException */ public boolean flush(boolean block, Selector s, long timeout, MutableInteger lastWrite) throws IOException { if (lastWrite!=null) lastWrite.set(1); - return true; //no network buffer in the regular channel + return true; } Modified: tomcat/trunk/java/org/apache/tomcat/util/net/SecureNioChannel.java URL: http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/tomcat/util/net/SecureNioChannel.java?rev=1226394&r1=1226393&r2=1226394&view=diff ============================================================================== --- tomcat/trunk/java/org/apache/tomcat/util/net/SecureNioChannel.java (original) +++ tomcat/trunk/java/org/apache/tomcat/util/net/SecureNioChannel.java Mon Jan 2 11:31:13 2012 @@ -105,13 +105,14 @@ public class SecureNioChannel extends Ni // NIO SSL METHODS //=========================================================================================== /** - * Returns true if the network buffer has been flushed out and is empty. + * Flush the channel. * * @param block Should a blocking write be used? * @param s * @param timeout * @param lastWrite - * @return + * @return <code>true</code> if the network buffer has been flushed out and + * is empty else <code>false</code> * @throws IOException */ @Override Modified: tomcat/trunk/modules/jdbc-pool/src/main/java/org/apache/tomcat/jdbc/pool/ConnectionPool.java URL: http://svn.apache.org/viewvc/tomcat/trunk/modules/jdbc-pool/src/main/java/org/apache/tomcat/jdbc/pool/ConnectionPool.java?rev=1226394&r1=1226393&r2=1226394&view=diff ============================================================================== --- tomcat/trunk/modules/jdbc-pool/src/main/java/org/apache/tomcat/jdbc/pool/ConnectionPool.java (original) +++ tomcat/trunk/modules/jdbc-pool/src/main/java/org/apache/tomcat/jdbc/pool/ConnectionPool.java Mon Jan 2 11:31:13 2012 @@ -783,9 +783,10 @@ public class ConnectionPool { } } /** - * return true if the connection TX termination succeeded + * Terminate the current transaction for the given connection. * @param con - * @return + * @return <code>true</code> if the connection TX termination succeeded + * otherwise <code>false</code> */ protected boolean terminateTransaction(PooledConnection con) { try { Modified: tomcat/trunk/modules/jdbc-pool/src/main/java/org/apache/tomcat/jdbc/pool/PoolConfiguration.java URL: http://svn.apache.org/viewvc/tomcat/trunk/modules/jdbc-pool/src/main/java/org/apache/tomcat/jdbc/pool/PoolConfiguration.java?rev=1226394&r1=1226393&r2=1226394&view=diff ============================================================================== --- tomcat/trunk/modules/jdbc-pool/src/main/java/org/apache/tomcat/jdbc/pool/PoolConfiguration.java (original) +++ tomcat/trunk/modules/jdbc-pool/src/main/java/org/apache/tomcat/jdbc/pool/PoolConfiguration.java Mon Jan 2 11:31:13 2012 @@ -797,29 +797,27 @@ public interface PoolConfiguration { * Set to true if you want the connection pool to commit any pending transaction when a connection is returned. * The default value is false, as this could result in committing data. * This parameter is only looked at if the {@link java.sql.Connection#getAutoCommit()} returns false - * @param commitOnReturn set to true if the pool should call {@link java.sql.Connection#commit()} when a connection is returned to the pool. - * Default is false + * @param commitOnReturn set to true if the pool should call {@link java.sql.Connection#commit()} when a connection is returned to the pool. + * Default is false */ public void setCommitOnReturn(boolean commitOnReturn); - + /** - * @see {@link PoolConfiguration#setCommitOnReturn(boolean)} - * @return + * @see PoolConfiguration#setCommitOnReturn(boolean) */ public boolean getCommitOnReturn(); - + /** * Set to true if you want the connection pool to rollback any pending transaction when a connection is returned. * The default value is false, as this could result in committing data. * This parameter is only looked at if the {@link java.sql.Connection#getAutoCommit()} returns false - * @param rollbackOnReturn set to true if the pool should call {@link java.sql.Connection#rollback()} when a connection is returned to the pool. - * Default is false + * @param rollbackOnReturn set to true if the pool should call {@link java.sql.Connection#rollback()} when a connection is returned to the pool. + * Default is false */ public void setRollbackOnReturn(boolean rollbackOnReturn); - + /** - * @see {@link PoolConfiguration#setRollbackOnReturn(boolean)} - * @return + * @see PoolConfiguration#setRollbackOnReturn(boolean) */ public boolean getRollbackOnReturn(); --------------------------------------------------------------------- To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org For additional commands, e-mail: dev-h...@tomcat.apache.org