db-derby-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From rhille...@apache.org
Subject svn commit: r1833280 [1/2] - in /db/derby/code/trunk/java: org.apache.derby.client/org/apache/derby/client/ org.apache.derby.client/org/apache/derby/client/am/ org.apache.derby.client/org/apache/derby/client/net/ org.apache.derby.commons/org/apache/der...
Date Sun, 10 Jun 2018 14:54:51 GMT
Author: rhillegas
Date: Sun Jun 10 14:54:50 2018
New Revision: 1833280

URL: http://svn.apache.org/viewvc?rev=1833280&view=rev
Log:
DERBY-6945: Cleanup javadoc warnings; commit derby-6945-38-aa-javadocCleanup.diff.

Modified:
    db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/BasicClientDataSource.java
    db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/ClientAutoloadedDriver.java
    db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/ClientDataSourceInterface.java
    db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/ClientBlob.java
    db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/ClientCallableStatement.java
    db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/ClientCallableStatement42.java
    db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/ClientClob.java
    db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/ClientConnection.java
    db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/ClientDatabaseMetaData.java
    db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/ClientJDBCObjectFactory.java
    db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/ClientMessageId.java
    db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/ClientPreparedStatement.java
    db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/ClientPreparedStatement42.java
    db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/ClientResultSet.java
    db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/ClientStatement.java
    db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/Configuration.java
    db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/Cursor.java
    db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/DateTime.java
    db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/DateTimeValue.java
    db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/Decimal.java
    db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/EncryptionManager.java
    db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/FailedProperties40.java
    db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/Lob.java
    db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/LogicalConnection.java
    db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/SQLExceptionFactory.java
    db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/Section.java
    db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/SignedBinary.java
    db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/SqlException.java
    db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/SqlWarning.java
    db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/Sqlca.java
    db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/Utils.java
    db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/Utils42.java
    db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/net/ClientJDBCObjectFactoryImpl.java
    db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/net/NetXAConnection.java
    db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/net/NetXAResource.java
    db/derby/code/trunk/java/org.apache.derby.commons/org/apache/derby/shared/common/drda/NaiveTrustManager.java
    db/derby/code/trunk/java/org.apache.derby.commons/org/apache/derby/shared/common/error/ErrorStringBuilder.java
    db/derby/code/trunk/java/org.apache.derby.commons/org/apache/derby/shared/common/error/MessageUtils.java
    db/derby/code/trunk/java/org.apache.derby.commons/org/apache/derby/shared/common/error/PublicAPI.java
    db/derby/code/trunk/java/org.apache.derby.commons/org/apache/derby/shared/common/error/StandardException.java
    db/derby/code/trunk/java/org.apache.derby.commons/org/apache/derby/shared/common/i18n/BundleFinder.java
    db/derby/code/trunk/java/org.apache.derby.commons/org/apache/derby/shared/common/i18n/LocaleFinder.java
    db/derby/code/trunk/java/org.apache.derby.commons/org/apache/derby/shared/common/i18n/MessageService.java
    db/derby/code/trunk/java/org.apache.derby.commons/org/apache/derby/shared/common/i18n/MessageUtil.java
    db/derby/code/trunk/java/org.apache.derby.commons/org/apache/derby/shared/common/info/JVMInfo.java
    db/derby/code/trunk/java/org.apache.derby.commons/org/apache/derby/shared/common/info/ProductVersionHolder.java
    db/derby/code/trunk/java/org.apache.derby.commons/org/apache/derby/shared/common/reference/Attribute.java
    db/derby/code/trunk/java/org.apache.derby.commons/org/apache/derby/shared/common/reference/Property.java
    db/derby/code/trunk/java/org.apache.derby.commons/org/apache/derby/shared/common/reference/SQLState.java
    db/derby/code/trunk/java/org.apache.derby.commons/org/apache/derby/shared/common/sanity/SanityManager.java
    db/derby/code/trunk/java/org.apache.derby.commons/org/apache/derby/shared/common/stream/HeaderPrintWriter.java
    db/derby/code/trunk/java/org.apache.derby.commons/org/apache/derby/shared/common/stream/InfoStreams.java
    db/derby/code/trunk/java/org.apache.derby.commons/org/apache/derby/shared/common/util/ArrayUtil.java
    db/derby/code/trunk/java/org.apache.derby.optionaltools/org/apache/derby/optional/api/LuceneIndexDescriptor.java
    db/derby/code/trunk/java/org.apache.derby.optionaltools/org/apache/derby/optional/api/LuceneUtils.java
    db/derby/code/trunk/java/org.apache.derby.optionaltools/org/apache/derby/optional/api/SimpleJsonUtils.java
    db/derby/code/trunk/java/org.apache.derby.optionaltools/org/apache/derby/optional/api/SimpleJsonVTI.java
    db/derby/code/trunk/java/org.apache.derby.server/org/apache/derby/drda/NetworkServerControl.java
    db/derby/code/trunk/java/org.apache.derby.server/org/apache/derby/impl/drda/NetworkServerControlImpl.java
    db/derby/code/trunk/java/org.apache.derby.server/org/apache/derby/impl/drda/ProtocolTestAdapter.java
    db/derby/code/trunk/java/org.apache.derby.server/org/apache/derby/impl/drda/package.html

Modified: db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/BasicClientDataSource.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/BasicClientDataSource.java?rev=1833280&r1=1833279&r2=1833280&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/BasicClientDataSource.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/BasicClientDataSource.java Sun Jun 10 14:54:50 2018
@@ -57,15 +57,19 @@ import org.apache.derby.shared.common.re
 import org.apache.derby.shared.common.reference.SQLState;
 
 /**
+ * <p>
  * This data source is suitable for client/server use of Derby,
  * running on Java 8 Compact Profile 2 or higher.
- * <p/>
+ * </p>
+ * <p>
  * BasicClientDataSource is similar to ClientDataSource except it
  * can not be used with JNDI, i.e. it does not implement
  * {@code javax.naming.Referenceable}.
- * <p/>
+ * </p>
+ * <p>
  *  * The standard attributes provided are, cf. e.g. table
  * 9.1 in the JDBC 4.2 specification.
+ * </p>
  * <ul>
  *   <li>databaseName</li>
  *   <li>dataSourceName</li>
@@ -73,15 +77,19 @@ import org.apache.derby.shared.common.re
  *   <li>password</li>
  *   <li>user</li>
  * </ul>
+ * <p>
  * These standard attributes are not supported:
+ * </p>
  * <ul>
  *   <li>networkProtocol</li>
  *   <li>roleName</li>
  * </ul>
+ * <p>
  * The Derby client driver also supports these attributes:
+ * </p>
  * <ul>
- *   <li>loginTimeout</li> @see javax.sql.CommonDataSource set/get
- *   <li>logWriter</li> @see javax.sql.CommonDataSource set/get
+ *   <li>loginTimeout @see javax.sql.CommonDataSource set/get</li>
+ *   <li>logWriter @see javax.sql.CommonDataSource set/get</li>
  *   <li>createDatabase</li>
  *   <li>connectionAttributes</li>
  *   <li>shutdownDatabase</li>
@@ -198,24 +206,30 @@ public class BasicClientDataSource
     }
 
     /**
+     * <p>
      * Creates a simple DERBY data source with default property values
      * for a non-pooling, non-distributed environment.  No particular
      * DatabaseName or other properties are associated with the data
      * source.
-     * <p/>
+     * </p>
+     * <p>
      * Every Java Bean should provide a constructor with no arguments
      * since many beanboxes attempt to instantiate a bean by invoking
      * its no-argument constructor.
+     * </p>
      */
     public BasicClientDataSource() {
         super();
     }
 
     /**
+     * <p>
      * The source security mechanism to use when connecting to a client data
      * source.
-     * <p/>
+     * </p>
+     * <p>
      * Security mechanism options are:
+     * </p>
      * <ul>
      *   <li> USER_ONLY_SECURITY
      *   <li> CLEAR_TEXT_PASSWORD_SECURITY
@@ -224,14 +238,16 @@ public class BasicClientDataSource
      *        user are encrypted
      *   <li> STRONG_PASSWORD_SUBSTITUTE_SECURITY
      * </ul> The default security mechanism is USER_ONLY SECURITY
-     * <p/>
+     * <p>
      * If the application specifies a security mechanism then it will be the
      * only one attempted. If the specified security mechanism is not
      * supported by the conversation then an exception will be thrown and
      * there will be no additional retries.
-     * <p/>
+     * </p>
+     * <p>
      * Both user and password need to be set for all security mechanism except
      * USER_ONLY_SECURITY.
+     * </p>
      */
     public final static short USER_ONLY_SECURITY =
         ClientDataSourceInterface.USER_ONLY_SECURITY;

Modified: db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/ClientAutoloadedDriver.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/ClientAutoloadedDriver.java?rev=1833280&r1=1833279&r2=1833280&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/ClientAutoloadedDriver.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/ClientAutoloadedDriver.java Sun Jun 10 14:54:50 2018
@@ -426,6 +426,7 @@ public class ClientAutoloadedDriver impl
     }
     
     /**
+     * <p>
      *This method returns an Implementation
      *of ClientJDBCObjectFactory depending on
      *VM under use
@@ -433,6 +434,9 @@ public class ClientAutoloadedDriver impl
      *ClientJDBCObjectFactoryImpl
      *(or)
      *ClientJDBCObjectFactoryImpl42
+     * </p>
+     *
+     * @return the client-side object factory
      */
     
     public static ClientJDBCObjectFactory getFactory() {

Modified: db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/ClientDataSourceInterface.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/ClientDataSourceInterface.java?rev=1833280&r1=1833279&r2=1833280&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/ClientDataSourceInterface.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/ClientDataSourceInterface.java Sun Jun 10 14:54:50 2018
@@ -61,10 +61,13 @@ public interface ClientDataSourceInterfa
     public boolean getRetrieveMessageText();
 
     /**
+     * <p>
      * The source security mechanism to use when connecting to a client data
      * source.
-     * <p/>
+     * </p>
+     * <p>
      * Security mechanism options are:
+     * </p>
      * <ul>
      *   <li> USER_ONLY_SECURITY
      *   <li> CLEAR_TEXT_PASSWORD_SECURITY
@@ -73,14 +76,16 @@ public interface ClientDataSourceInterfa
      *        user are encrypted
      *   <li> STRONG_PASSWORD_SUBSTITUTE_SECURITY
      * </ul> The default security mechanism is USER_ONLY SECURITY
-     * <p/>
+     * <p>
      * If the application specifies a security mechanism then it will be the
      * only one attempted. If the specified security mechanism is not
      * supported by the conversation then an exception will be thrown and
      * there will be no additional retries.
-     * <p/>
+     * </p>
+     * <p>
      * Both user and password need to be set for all security mechanism except
      * USER_ONLY_SECURITY.
+     * </p>
      */
     public final static short USER_ONLY_SECURITY =
         (short)NetConfiguration.SECMEC_USRIDONL;

Modified: db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/ClientBlob.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/ClientBlob.java?rev=1833280&r1=1833279&r2=1833280&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/ClientBlob.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/ClientBlob.java Sun Jun 10 14:54:50 2018
@@ -732,7 +732,7 @@ public class ClientBlob extends Lob impl
     /**
      * Materialize the stream used for input to the database.
      *
-     * @throws SqlException
+     * @throws SqlException on error
      */
     protected void materializeStream() throws SqlException 
     {

Modified: db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/ClientCallableStatement.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/ClientCallableStatement.java?rev=1833280&r1=1833279&r2=1833280&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/ClientCallableStatement.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/ClientCallableStatement.java Sun Jun 10 14:54:50 2018
@@ -97,7 +97,7 @@ public class ClientCallableStatement ext
      * @param cpc         The PooledConnection object that will be used to 
      *                    notify the PooledConnection reference of the Error 
      *                    Occurred and the Close events.
-     * @throws SqlException
+     * @throws SqlException on error
      */
     public ClientCallableStatement(Agent agent,
                              ClientConnection connection,

Modified: db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/ClientCallableStatement42.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/ClientCallableStatement42.java?rev=1833280&r1=1833279&r2=1833280&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/ClientCallableStatement42.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/ClientCallableStatement42.java Sun Jun 10 14:54:50 2018
@@ -43,7 +43,7 @@ public class ClientCallableStatement42 e
      * @param cpc         The PooledConnection object that will be used to 
      *                    notify the PooledConnection reference of the Error 
      *                    Occurred and the Close events.
-     * @throws SqlException
+     * @throws SqlException on error
      */
     public ClientCallableStatement42(Agent agent,
         ClientConnection connection,

Modified: db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/ClientClob.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/ClientClob.java?rev=1833280&r1=1833279&r2=1833280&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/ClientClob.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/ClientClob.java Sun Jun 10 14:54:50 2018
@@ -995,7 +995,7 @@ public class ClientClob extends Lob impl
     /**
      * Materialize the stream used for input to the database.
      *
-     * @throws SqlException
+     * @throws SqlException on error
      */
     protected void materializeStream()
         throws SqlException {

Modified: db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/ClientConnection.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/ClientConnection.java?rev=1833280&r1=1833279&r2=1833280&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/ClientConnection.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/ClientConnection.java Sun Jun 10 14:54:50 2018
@@ -1110,7 +1110,11 @@ public abstract class ClientConnection
      */
     protected abstract boolean serverSupportsLocators();
 
-    /** Return true if the server supports nanoseconds in timestamps */
+    /**
+     * Return true if the server supports nanoseconds in timestamps
+     *
+     * @return whether the server supports nanoseconds in timestamps
+     */
     protected abstract boolean serverSupportsTimestampNanoseconds();
 
     public int getTransactionIsolation() throws SQLException {
@@ -1263,7 +1267,7 @@ public abstract class ClientConnection
      * compilation. This is not part of the java.sql.Connection interface, and
      * is only intended for use with statement caching.
      * @return the name of the current schema
-     * @throws java.sql.SQLException
+     * @throws java.sql.SQLException on error
      */
     public String getCurrentSchemaName() throws SQLException {
         try {
@@ -2378,19 +2382,26 @@ public abstract class ClientConnection
     abstract protected void reset_(LogWriter logWriter) throws SqlException;
 
     /**
-     * <br>NOTE:</br>The following comments are valid for the changes done as
+     * <p>
+     * <b>NOTE:</b>The following comments are valid for the changes done as
      * part of implementing statement caching only (see DERBY-3313 and linked
      * issues).
+     * </p>
      * <p>
      * We don't reset the isolation level to unknown unconditionally, as this
      * forces us to go to the server all the time. Since the value should now
      * be valid (DERBY-3192), we check if it has been changed from the default.
+     * </p>
      *
+     * @param isDeferredReset True if this is for a deferred reset
      * @param closeStatementsOnClose is used to differentiate between
      *      cases where statement pooling is enabled or not. If {@code true}, it
      *      means statement pooling is disabled and the statements are fully
      *      reset, which includes a re-prepare. If {@code false}, statement
      *      pooling is enabled, and a more lightweight reset procedure is used.
+     * @param xares XA resource
+     *
+     * @throws SqlException on error
      */
     protected void completeReset(boolean isDeferredReset,
                                  boolean closeStatementsOnClose,
@@ -2586,7 +2597,7 @@ public abstract class ClientConnection
      *
      * @return An object that implements the <code>Blob</code> interface
      * @throws SQLException if an object that implements the
-     * </code>Blob</code> interface can not be constructed.
+     * Blob interface can not be constructed.
      *
      */
     
@@ -2637,7 +2648,11 @@ public abstract class ClientConnection
         return blob;
     }
 
-    /** Return true if the connection is aborting */
+    /**
+     * Return true if the connection is aborting
+     *
+     * @return true if we are in the middle of aborting
+     */
     public  boolean isAborting() { return aborting_; }
     
     /** Begin aborting the connection */

Modified: db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/ClientDatabaseMetaData.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/ClientDatabaseMetaData.java?rev=1833280&r1=1833279&r2=1833280&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/ClientDatabaseMetaData.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/ClientDatabaseMetaData.java Sun Jun 10 14:54:50 2018
@@ -2831,10 +2831,11 @@ public abstract class ClientDatabaseMeta
     }
 
     /**
+     * <p>
      * Returns a list of the client info properties supported by the
      * driver. The result set contains the following columns:
+     * </p>
      *
-     * <p>
      * <ol>
      *  <li>NAME String=&gt; The name of the client info property.</li>
      *  <li>MAX_LEN int=&gt; The maximum length of the value for the
@@ -3011,6 +3012,8 @@ public abstract class ClientDatabaseMeta
      * A "public" version of checkForClosedConnection() that throws
      * SQLException instead of SqlException.  In particular this is used
      * by all the DatabaseMetadata methods
+     *
+     * @throws java.sql.SQLException on error
      */
     protected void checkForClosedConnection() throws SQLException
     {

Modified: db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/ClientJDBCObjectFactory.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/ClientJDBCObjectFactory.java?rev=1833280&r1=1833279&r2=1833280&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/ClientJDBCObjectFactory.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/ClientJDBCObjectFactory.java Sun Jun 10 14:54:50 2018
@@ -46,6 +46,14 @@ public interface ClientJDBCObjectFactory
      * This method is used to return an instance of the {@link
      * org.apache.derby.client.ClientPooledConnection} class which
      * implements {@code javax.sql.PooledConnection}.
+     *
+     * @param ds The data source
+     * @param logWriter The machinery for writing diagnostic messages
+     * @param user The user name
+     * @param password The corresponding password
+     *
+     * @return a pooled connection
+     * @throws java.sql.SQLException on error
      */
     ClientPooledConnection newClientPooledConnection(
             BasicClientDataSource ds,
@@ -53,10 +61,18 @@ public interface ClientJDBCObjectFactory
             String user,
             String password) throws SQLException;
     
-        /**
+    /**
      * This method is used to return an instance of
      * ClientXAConnection (or ClientXAConnection40) class which
      * implements {@code javax.sql.XAConnection}.
+     *
+     * @param ds The data source
+     * @param logWriter The machinery for writing diagnostic messages
+     * @param user The user name
+     * @param password The corresponding password
+     *
+     * @return an XA connection
+     * @throws java.sql.SQLException on error
      */
     ClientXAConnection newClientXAConnection(BasicClientDataSource ds,
             LogWriter logWriter,String user,String password)
@@ -80,7 +96,7 @@ public interface ClientJDBCObjectFactory
      *                    notify the PooledConnection reference of the Error 
      *                    Occurred and the Close events.
      * @return a CallableStatement object
-     * @throws SqlException
+     * @throws SqlException on error
      */
     ClientCallableStatement newCallableStatement(Agent agent,
             ClientConnection connection, String sql,
@@ -91,6 +107,12 @@ public interface ClientJDBCObjectFactory
      * Returns an instance of LogicalConnection.
      * This method returns an instance of LogicalConnection
      * (or LogicalConnection40) which implements {@code java.sql.Connection}.
+     *
+     * @param physicalConnection The physical connection
+     * @param pooledConnection The pooled connection
+     *
+     * @return a logical connection
+     * @throws SqlException on error
      */
     LogicalConnection newLogicalConnection(
                     ClientConnection physicalConnection,
@@ -134,7 +156,7 @@ public interface ClientJDBCObjectFactory
      *            error occurred events that occur back to the
      *            ClientPooledConnection.
      * @return a PreparedStatement object
-     * @throws SqlException
+     * @throws SqlException on error
      */
     ClientPreparedStatement newPreparedStatement(Agent agent,
             ClientConnection connection,
@@ -171,7 +193,7 @@ public interface ClientJDBCObjectFactory
      *            error occurred events that occur back to the
      *            ClientPooledConnection.
      * @return a PreparedSatement object
-     * @throws SqlException
+     * @throws SqlException on error
      */
     ClientPreparedStatement newPreparedStatement(Agent agent,
             ClientConnection connection,String sql,
@@ -210,6 +232,16 @@ public interface ClientJDBCObjectFactory
      * This method returns an instance of NetConnection (or NetConnection40)
      * class which extends from ClientConnection
      * this implements the java.sql.Connection interface
+     *
+     * @param logWriter Machinery for logging diagnostics
+     * @param driverManagerLoginTimeout Connection timeout
+     * @param serverName Name of server
+     * @param portNumber Server port
+     * @param databaseName Name of database
+     * @param properties Connection properties
+     *
+     * @return a client connection
+     * @throws SqlException on error
      */
     ClientConnection newNetConnection(
             LogWriter logWriter,
@@ -221,6 +253,16 @@ public interface ClientJDBCObjectFactory
      * This method returns an instance of NetConnection (or
      * NetConnection40) class which extends from ClientConnection.  This
      * implements the {@code java.sql.Connection} interface.
+     *
+     * @param logWriter Machinery for logging diagnostics
+     * @param user User name
+     * @param password Corresponding password
+     * @param dataSource Data source to connect to
+     * @param rmId id
+     * @param isXAConn True if an XA connection is needed
+     *
+     * @return a client connection
+     * @throws SqlException on error
      */
     ClientConnection newNetConnection(
             LogWriter logWriter,
@@ -249,7 +291,8 @@ public interface ClientJDBCObjectFactory
      *                     NetConnection constructor was called. This is used
      *                     to pass StatementEvents back to the pooledConnection
      *                     object
-     * @throws             SqlException
+     * @return a client connection
+     * @throws             SqlException on error
      */
     ClientConnection newNetConnection(
             LogWriter logWriter,
@@ -261,6 +304,22 @@ public interface ClientJDBCObjectFactory
      * This method returns an instance of NetResultSet(or
      * NetResultSet40) which extends from ClientResultSet which implements
      * {@code java.sql.ResultSet}.
+     *
+     * @param netAgent The wrapped agent
+     * @param netStatement The wrapped statement
+     * @param cursor The wrapped cursor
+     * @param qryprctyp DRDA variable
+     * @param sqlcsrhld DRDA variable
+     * @param qryattscr DRDA variable
+     * @param qryattsns DRDA variable
+     * @param qryattset DRDA variable
+     * @param qryinsid DRDA variable
+     * @param actualResultSetType Type of result set
+     * @param actualResultSetConcurrency Concurrency level
+     * @param actualResultSetHoldability Whether results are holdable
+     *
+     * @return a result set
+     * @throws SqlException on error
      */
     ClientResultSet newNetResultSet(
             Agent netAgent,
@@ -280,6 +339,11 @@ public interface ClientJDBCObjectFactory
      * This method provides an instance of NetDatabaseMetaData (or
      * NetDatabaseMetaData40) which extends from ClientDatabaseMetaData
      * which implements {@code java.sql.DatabaseMetaData}.
+     *
+     * @param netAgent Wrapped agent
+     * @param netConnection Wrapped connection
+     *
+     * @return database meta data
      */
     ClientDatabaseMetaData newNetDatabaseMetaData(Agent netAgent,
             ClientConnection netConnection);
@@ -296,7 +360,7 @@ public interface ClientJDBCObjectFactory
      * @param columnNames       String[]
      * @param columnIndexes     int[]
      * @return a {@code java.sql.Statement} implementation
-     * @throws SqlException
+     * @throws SqlException on error
      *
      */
      ClientStatement newStatement(Agent agent,
@@ -340,6 +404,14 @@ public interface ClientJDBCObjectFactory
     
     /**
      * Creates a BatchUpdateException depending on the JVM level.
+     *
+     * @param logWriter Machinery for writing log messages
+     * @param msgid Client message handle
+     * @param args Arguments to be plugged into the message
+     * @param updateCounts Update counts to include in message
+     * @param cause Original exception
+     *
+     * @return a batch exception
      */
     public BatchUpdateException newBatchUpdateException
         ( LogWriter logWriter, ClientMessageId msgid, Object[] args, long[] updateCounts, SqlException cause );

Modified: db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/ClientMessageId.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/ClientMessageId.java?rev=1833280&r1=1833279&r2=1833280&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/ClientMessageId.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/ClientMessageId.java Sun Jun 10 14:54:50 2018
@@ -31,7 +31,11 @@ public class ClientMessageId
 {
     public String msgid;
     
-    /** Creates a new instance of MessageId */
+    /**
+     * Creates a new instance of MessageId
+     *
+     * @param msgid The message id name
+     */
     public ClientMessageId(String msgid)
     {
         this.msgid = msgid;

Modified: db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/ClientPreparedStatement.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/ClientPreparedStatement.java?rev=1833280&r1=1833279&r2=1833280&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/ClientPreparedStatement.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/ClientPreparedStatement.java Sun Jun 10 14:54:50 2018
@@ -171,7 +171,7 @@ public class ClientPreparedStatement ext
      *            It is used to pass the Statement closed and the Statement
      *            error occurred events that occur back to the
      *            ClientPooledConnection.
-     * @throws SqlException
+     * @throws SqlException on error
      *
      */
 
@@ -231,7 +231,7 @@ public class ClientPreparedStatement ext
      *            it is used to pass the Statement closed and the Statement
      *            error occurred events that occur back to the
      *            ClientPooledConnection.
-     * @throws SqlException
+     * @throws SqlException on error
      */
     public ClientPreparedStatement(Agent agent,
                              ClientConnection connection,
@@ -3180,6 +3180,8 @@ public class ClientPreparedStatement ext
      * <p>
      * Check for closed statement and extract the SQLException if it is raised.
      * </p>
+     *
+     * @throws java.sql.SQLException on error
      */
     protected void    checkStatus() throws SQLException
     {

Modified: db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/ClientPreparedStatement42.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/ClientPreparedStatement42.java?rev=1833280&r1=1833279&r2=1833280&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/ClientPreparedStatement42.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/ClientPreparedStatement42.java Sun Jun 10 14:54:50 2018
@@ -33,6 +33,14 @@ public class  ClientPreparedStatement42
      * It has the ClientPooledConnection as one of its parameters 
      * this is used to raise the Statement Events when the prepared
      * statement is closed
+     *
+     * @param agent The wrapped agent
+     * @param connection The wrapped client connection
+     * @param sql The sql being executed
+     * @param section The section
+     * @param cpc The wrapped pooled connection
+     *
+     * @throws SqlException on error
      */
     public ClientPreparedStatement42
         (
@@ -49,6 +57,19 @@ public class  ClientPreparedStatement42
      * It has the ClientPooledConnection as one of its parameters 
      * this is used to raise the Statement Events when the prepared
      * statement is closed
+     *
+     * @param agent The wrapped agent
+     * @param connection The wrapped client connection
+     * @param sql The sql being executed
+     * @param type The type
+     * @param concurrency The type of concurrency
+     * @param holdability The holdability
+     * @param autoGeneratedKeys The auto generated keys
+     * @param columnNames The column names
+     * @param columnIndexes the column indexes
+     * @param cpc The wrapped pooled connection
+     *
+     * @throws SqlException on error
      */
     public ClientPreparedStatement42
         (

Modified: db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/ClientResultSet.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/ClientResultSet.java?rev=1833280&r1=1833279&r2=1833280&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/ClientResultSet.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/ClientResultSet.java Sun Jun 10 14:54:50 2018
@@ -5386,7 +5386,7 @@ public abstract class ClientResultSet im
      * result set is actually being closed. Subclasses may override
      * this method if work needs to be done before closing.
      *
-     * @exception SqlException
+     * @exception SqlException on error
      */
     protected abstract void preClose_() throws SqlException;
 
@@ -6438,8 +6438,8 @@ public abstract class ClientResultSet im
      *
      * @param columnName -
      *            the name of the Clob column
-     * @param x -
-     *            the new column value
+     * @param x the new column value
+     * @param length how many characters to update
      * @exception SQLException
      *                Feature not implemented for now.
      */

Modified: db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/ClientStatement.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/ClientStatement.java?rev=1833280&r1=1833279&r2=1833280&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/ClientStatement.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/ClientStatement.java Sun Jun 10 14:54:50 2018
@@ -41,6 +41,8 @@ public class ClientStatement implements
     /**
      * Debug method used to test the setLargeMaxRows() method added by JDBC 4.2.
      * This method is a NOP on a production (insane) build of Derby.
+     *
+     * @param newBase Base value to add to row count for debug purposes
      */
     public  static  void    setFetchedRowBase( long newBase )
     {

Modified: db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/Configuration.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/Configuration.java?rev=1833280&r1=1833279&r2=1833280&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/Configuration.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/Configuration.java Sun Jun 10 14:54:50 2018
@@ -157,6 +157,8 @@ public class Configuration {
     
     /**
      * Check to see if the jvm version is such that JDBC 4.2 is supported
+     *
+     * @return true if jdbc 4.2 is supported
      */
     
     public static boolean supportsJDBC42() {

Modified: db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/Cursor.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/Cursor.java?rev=1833280&r1=1833279&r2=1833280&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/Cursor.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/Cursor.java Sun Jun 10 14:54:50 2018
@@ -263,8 +263,8 @@ public abstract class Cursor {
      * server
      * @return {@code true} if the current row position is a
      * valid row position.
-     * @exception SqlException
-     * @exception DisconnectException
+     * @exception SqlException on error
+     * @exception DisconnectException on error
      */
     protected abstract boolean
         calculateColumnOffsetsForRow_(int row, boolean allowServerFetch)
@@ -300,6 +300,8 @@ public abstract class Cursor {
      * Minion of ResultSet#rowUpdated.
      *
      * @see Cursor#setIsRowUpdated
+     *
+     * @return true if this row was updated
      */
     public final boolean getIsRowUpdated() {
         return isRowUpdated_;
@@ -310,6 +312,8 @@ public abstract class Cursor {
      * Minion of ResultSet#rowDeleted.
      *
      * @see Cursor#setIsUpdataDeleteHole
+     *
+     * @return true if the row was deleted
      */
     public final boolean getIsUpdateDeleteHole() {
         return isUpdateDeleteHole_;

Modified: db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/DateTime.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/DateTime.java?rev=1833280&r1=1833279&r2=1833280&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/DateTime.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/DateTime.java Sun Jun 10 14:54:50 2018
@@ -33,13 +33,15 @@ import org.apache.derby.client.net.Typde
 
 
 /**
+ * <p>
  * High performance converters from date/time byte encodings to JDBC Date, Time and Timestamp objects.
- * <p/>
+ * </p>
+ * <p>
  * Using this class for direct date/time conversions from bytes offers superior performance over the alternative method
  * of first constructing a Java String from the encoded bytes, and then using {@link java.sql.Date#valueOf
  * java.sql.Date.valueOf()}, {@link java.sql.Time#valueOf java.sql.Time.valueOf()} or {@link java.sql.Timestamp#valueOf
  * java.sql.Timestamp.valueOf()}.
- * <p/>
+ * </p>
  */
 public class DateTime {
 
@@ -256,7 +258,7 @@ public class DateTime {
      * @param date    date value
      * @return DateTime.dateRepresentationLength. This is the fixed length in 
      * bytes taken to represent the date value
-     * @throws SqlException
+     * @throws SqlException on error
      */
     public static final int dateToDateBytes(byte[] buffer,
                                             int offset,
@@ -340,7 +342,7 @@ public class DateTime {
      * @param timestamp  timestamp value
      * @param supportsTimestampNanoseconds true if the server supports nanoseconds in timestamps
      * @return DateTime.timestampRepresentationLength. This is the fixed  length in bytes, taken to represent the timestamp value
-     * @throws SqlException
+     * @throws SqlException on error
      */
     public static final int timestampToTimestampBytes(byte[] buffer,
                                                       int offset,
@@ -643,6 +645,8 @@ public class DateTime {
      * and then converted to bytes using UTF8 encoding
      *
      * @param supportsTimestampNanoseconds true if the connection supports nanoseconds in timestamps
+     *
+     * @return the timestamp length
      */
     public static int getTimestampLength( boolean supportsTimestampNanoseconds )
     {

Modified: db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/DateTimeValue.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/DateTimeValue.java?rev=1833280&r1=1833279&r2=1833280&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/DateTimeValue.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/DateTimeValue.java Sun Jun 10 14:54:50 2018
@@ -95,6 +95,8 @@ public class DateTimeValue {
     /**
      * Create an instance from a {@code java.sql.Date} using the default
      * calendar.
+     *
+     * @param date The wrapped date
      */
     public DateTimeValue(Date date) {
         this(date, Calendar.getInstance());
@@ -103,6 +105,8 @@ public class DateTimeValue {
     /**
      * Create an instance from a {@code java.sql.Time} using the default
      * calendar.
+     *
+     * @param time The wrapped time value
      */
     public DateTimeValue(Time time) {
         this(time, Calendar.getInstance());
@@ -111,6 +115,8 @@ public class DateTimeValue {
     /**
      * Create an instance from a {@code java.sql.Timestamp} using the default
      * calendar.
+     *
+     * @param ts The wrapped timestamp value
      */
     public DateTimeValue(Timestamp ts) {
         this(ts, Calendar.getInstance());
@@ -131,6 +137,8 @@ public class DateTimeValue {
 
     /**
      * Get the year component.
+     *
+     * @return the year component.
      */
     public int getYear() {
         return year;
@@ -138,6 +146,8 @@ public class DateTimeValue {
 
     /**
      * Get the month component. First month is 0 ({@code Calendar.JANUARY}).
+     *
+     * @return the month component
      */
     public int getMonth() {
         return month;
@@ -145,6 +155,8 @@ public class DateTimeValue {
 
     /**
      * Get day of month component. First day of the month is 1.
+     *
+     * @return day of month component
      */
     public int getDayOfMonth() {
         return day;
@@ -152,6 +164,8 @@ public class DateTimeValue {
 
     /**
      * Get hour of day component (24 hour clock).
+     *
+     * @return hour of day component
      */
     public int getHours() {
         return hours;
@@ -159,6 +173,8 @@ public class DateTimeValue {
 
     /**
      * Get minute component.
+     *
+     * @return minute component.
      */
     public int getMinutes() {
         return minutes;
@@ -166,6 +182,8 @@ public class DateTimeValue {
 
     /**
      * Get second component.
+     *
+     * @return second component.
      */
     public int getSeconds() {
         return seconds;
@@ -173,6 +191,8 @@ public class DateTimeValue {
 
     /**
      * Get nanosecond component.
+     *
+     * @return nanosecond component.
      */
     public int getNanos() {
         return nanos;

Modified: db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/Decimal.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/Decimal.java?rev=1833280&r1=1833279&r2=1833280&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/Decimal.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/Decimal.java Sun Jun 10 14:54:50 2018
@@ -350,6 +350,15 @@ public class Decimal {
 
     /**
      * Write a Java <code>java.math.BigDecimal</code> to packed decimal bytes.
+     *
+     * @param buffer Buffer to which to write the packed decimal
+     * @param offset Offset into the buffer at which to write
+     * @param b The BigDecimal to write
+     * @param declaredPrecision Its precision
+     * @param declaredScale Its scale
+     *
+     * @return the number of bytes written
+     * @throws SqlException on error
      */
     public static final int bigDecimalToPackedDecimalBytes(byte[] buffer,
                                                            int offset,

Modified: db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/EncryptionManager.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/EncryptionManager.java?rev=1833280&r1=1833279&r2=1833280&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/EncryptionManager.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/EncryptionManager.java Sun Jun 10 14:54:50 2018
@@ -565,6 +565,7 @@ public class EncryptionManager {
      * @param targetSeed_ random server seed (RDr)
      *
      * @return a password substitute.
+     * @throws SqlException on error
      */
     public byte[] substitutePassword(
                 String userName,

Modified: db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/FailedProperties40.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/FailedProperties40.java?rev=1833280&r1=1833279&r2=1833280&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/FailedProperties40.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/FailedProperties40.java Sun Jun 10 14:54:50 2018
@@ -89,7 +89,7 @@ public class FailedProperties40 {
      * failed properties (as specified in the javadoc for
      * java.sql.SQLClientInfoException).
      *
-     * @return a <code>Map&glt;String,ClientInfoStatus&gt;</code> object with
+     * @return a <code>Map&lt;String,ClientInfoStatus&gt;</code> object with
      * the failed property keys and the reason why each failed
      */
     public Map<String,ClientInfoStatus> getProperties() { return failedProps_; }

Modified: db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/Lob.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/Lob.java?rev=1833280&r1=1833279&r2=1833280&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/Lob.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/Lob.java Sun Jun 10 14:54:50 2018
@@ -184,7 +184,7 @@ public abstract class Lob implements Uni
      * #materializedStream(InputStream, String) can be called with subclass
      * specific parameters and the result assigned to the right stream.
      *
-     * @throws SqlException
+     * @throws SqlException on error
      */
     protected abstract void materializeStream() throws SqlException;
 

Modified: db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/LogicalConnection.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/LogicalConnection.java?rev=1833280&r1=1833279&r2=1833280&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/LogicalConnection.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/LogicalConnection.java Sun Jun 10 14:54:50 2018
@@ -363,6 +363,7 @@ public class LogicalConnection implement
      * correct implementation class of the logical metadata object.
      *
      * @return A logical database metadata object.
+     * @throws java.sql.SQLException on error
      */
     protected LogicalDatabaseMetaData newLogicalDatabaseMetaData()
             throws SQLException {
@@ -638,6 +639,8 @@ public class LogicalConnection implement
      * <p>
      * <em>NOTE:</em> This method was added for testing purposes. Avoid use in
      * production code if possible.
+     *
+     * @return transaction id
      **/
     public int getTransactionID() {
         if (physicalConnection_ == null) {

Modified: db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/SQLExceptionFactory.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/SQLExceptionFactory.java?rev=1833280&r1=1833279&r2=1833280&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/SQLExceptionFactory.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/SQLExceptionFactory.java Sun Jun 10 14:54:50 2018
@@ -57,8 +57,11 @@ public class SQLExceptionFactory {
      * creates jdbc4.0 SQLException and its subclass based on sql state
      * 
      * @param message description of the 
-     * @param sqlState 
+     * @param sqlState the sqlstate
      * @param errCode derby error code
+     * @param args the arguments to plug into the message text
+     *
+     * @return a SQLException with the indicated message
      */
     public SQLException getSQLException (String message, String sqlState, 
                                          int errCode, Object []args) { 

Modified: db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/Section.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/Section.java?rev=1833280&r1=1833279&r2=1833280&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/Section.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/Section.java Sun Jun 10 14:54:50 2018
@@ -95,6 +95,8 @@ public class Section {
 
     /**
      * retrieve the package name and consistency token information
+     *
+     * @return the package name and consistency token information
      */
     public byte[] getPKGNAMCBytes() {
         return PKGNAMCBytes != null ?

Modified: db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/SignedBinary.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/SignedBinary.java?rev=1833280&r1=1833279&r2=1833280&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/SignedBinary.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/SignedBinary.java Sun Jun 10 14:54:50 2018
@@ -45,6 +45,11 @@ public class SignedBinary {
     /**
      * Build a Java short from a 2-byte signed binary representation.
      *
+     * @param buffer The buffer to read from
+     * @param offset The offset to start reading at
+     *
+     * @return the value at that address
+     *
      * @throws IllegalArgumentException if the specified byte order is not recognized.
      */
     public static short getShort(byte[] buffer, int offset) {
@@ -55,6 +60,12 @@ public class SignedBinary {
     /**
      * Build a Java int from a 4-byte signed binary representation.
      *
+     *
+     * @param buffer The buffer to read from
+     * @param offset The offset to start reading at
+     *
+     * @return the value at that address
+     *
      * @throws IllegalArgumentException if the specified byte order is not recognized.
      */
     public static final int getInt(byte[] buffer, int offset) {
@@ -67,6 +78,12 @@ public class SignedBinary {
     /**
      * Build a Java long from an 8-byte signed binary representation.
      *
+     *
+     * @param buffer The buffer to read from
+     * @param offset The offset to start reading at
+     *
+     * @return the value at that address
+     *
      * @throws IllegalArgumentException if the specified byte order is not recognized.
      */
     public static final long getLong(byte[] buffer, int offset) {

Modified: db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/SqlException.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/SqlException.java?rev=1833280&r1=1833279&r2=1833280&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/SqlException.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/SqlException.java Sun Jun 10 14:54:50 2018
@@ -299,6 +299,8 @@ public class SqlException extends Except
      * so the don't have to throw SQLException, which, through the chain of 
      * dependencies would force more and more internal routines to throw
      * SQLException
+     *
+     * @param wrapme The original exception
      */
     public SqlException(SQLException wrapme)
     {
@@ -308,6 +310,8 @@ public class SqlException extends Except
     
     /**
      * Convert this SqlException into a java.sql.SQLException
+     *
+     * @return a corresponding SQLException
      */
     public SQLException getSQLException()
     {

Modified: db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/SqlWarning.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/SqlWarning.java?rev=1833280&r1=1833279&r2=1833280&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/SqlWarning.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/SqlWarning.java Sun Jun 10 14:54:50 2018
@@ -56,6 +56,8 @@ public class SqlWarning extends SqlExcep
     
     /**
      * Get the java.sql.SQLWarning for this SqlWarning
+     *
+     * @return the wrapped sql warning
      */
     public SQLWarning getSQLWarning()
     {

Modified: db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/Sqlca.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/Sqlca.java?rev=1833280&r1=1833279&r2=1833280&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/Sqlca.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/Sqlca.java Sun Jun 10 14:54:50 2018
@@ -119,6 +119,8 @@ public abstract class Sqlca {
      * </ul>
      *
      * @see org.apache.derby.impl.drda.DRDAConnThread#getSqlCode(java.sql.SQLException)
+     *
+     * @return the error code
      */
     public synchronized int getErrorCode() {
         // Warning or other non-error, return SQL code.

Modified: db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/Utils.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/Utils.java?rev=1833280&r1=1833279&r2=1833280&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/Utils.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/Utils.java Sun Jun 10 14:54:50 2018
@@ -202,7 +202,12 @@ public final class Utils {
         return sqlca.getSqlCode();
     }
 
-    /** Squash an array of longs into an array of ints */
+    /**
+     * Squash an array of longs into an array of ints
+     *
+     * @param longs The array of longs to squash
+     * @return a corresponding array of ints
+     */
     public static  int[]   squashLongs( long[] longs )
     {
         int count = (longs == null) ? 0 : longs.length;

Modified: db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/Utils42.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/Utils42.java?rev=1833280&r1=1833279&r2=1833280&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/Utils42.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/Utils42.java Sun Jun 10 14:54:50 2018
@@ -38,6 +38,12 @@ public final class Utils42
      * <p>
      * Get the int type id from java.sql.Types which corresponds to the SQLType.
      * </p>
+     *
+     * @param agent The agent
+     * @param sqlType The SQLType to map
+     *
+     * @return the corresponding type id
+     * @throws SQLException on error
      */
     public  static  int getTypeAsInt( Agent agent, SQLType sqlType )
         throws SQLException

Modified: db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/net/ClientJDBCObjectFactoryImpl.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/net/ClientJDBCObjectFactoryImpl.java?rev=1833280&r1=1833279&r2=1833280&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/net/ClientJDBCObjectFactoryImpl.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/net/ClientJDBCObjectFactoryImpl.java Sun Jun 10 14:54:50 2018
@@ -110,7 +110,7 @@ public class ClientJDBCObjectFactoryImpl
      *                    Occurred and the Close events.
      * @return a {@link org.apache.derby.client.am.ClientCallableStatement}
      *         object
-     * @throws SqlException
+     * @throws SqlException on error
      */
     public ClientCallableStatement newCallableStatement(Agent agent,
             ClientConnection connection,
@@ -173,7 +173,7 @@ public class ClientJDBCObjectFactoryImpl
      *            error occurred events that occur back to the
      *            ClientPooledConnection.
      * @return a PreparedStatement object
-     * @throws SqlException
+     * @throws SqlException on error
      */
     public ClientPreparedStatement newPreparedStatement(Agent agent,
             ClientConnection connection,
@@ -210,7 +210,7 @@ public class ClientJDBCObjectFactoryImpl
      *            error occurred events that occur back to the
      *            ClientPooledConnection.
      * @return a PreparedStatement object
-     * @throws SqlException
+     * @throws SqlException on error
      *
      */
     public ClientPreparedStatement newPreparedStatement(Agent agent,
@@ -315,7 +315,7 @@ public class ClientJDBCObjectFactoryImpl
      *                     pass StatementEvents back to the pooledConnection
      *                     object.
      * @return a {@link ClientConnection} object
-     * @throws             SqlException
+     * @throws             SqlException on error
      */
     public ClientConnection newNetConnection(
             LogWriter logWriter,String user,
@@ -368,7 +368,7 @@ public class ClientJDBCObjectFactoryImpl
      * @param columnNames       String[]
      * @param columnIndexes     int[]
      * @return a ClientStatement implementation
-     * @throws SqlException
+     * @throws SqlException on error
      *
      */
      public ClientStatement newStatement(Agent agent,
@@ -450,7 +450,17 @@ public class ClientJDBCObjectFactoryImpl
 
         return bue;
     }
-    /** This method is overridden on JVM 8 */
+    /**
+     * This method is overridden on JVM 8
+     *
+     * @param message The message to put in the exception
+     * @param sqlState The SQLState to put in the exception
+     * @param errorCode The errorCode to put in the exception
+     * @param updateCounts The array of update counts
+     * @param cause The original exception
+     *
+     * @return a batch update exception
+     */
     protected   BatchUpdateException   newBatchUpdateException
         ( String message, String sqlState, int errorCode, long[] updateCounts, SqlException cause  )
     {

Modified: db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/net/NetXAConnection.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/net/NetXAConnection.java?rev=1833280&r1=1833279&r2=1833280&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/net/NetXAConnection.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/net/NetXAConnection.java Sun Jun 10 14:54:50 2018
@@ -58,7 +58,7 @@ public class NetXAConnection {
      *                     NetConnection constructor was called. This is used
      *                     to pass StatementEvents back to the pooledConnection
      *                     object
-     * @throws SqlException
+     * @throws SqlException on error
      * 
      */
     public NetXAConnection(

Modified: db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/net/NetXAResource.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/net/NetXAResource.java?rev=1833280&r1=1833279&r2=1833280&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/net/NetXAResource.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/net/NetXAResource.java Sun Jun 10 14:54:50 2018
@@ -170,16 +170,21 @@ public class NetXAResource implements XA
     }
 
     /**
+     * <p>
      * Ends the work performed on behalf of a transaction branch. The resource manager dissociates the XA resource from
      * the transaction branch specified and let the transaction be completed.
-     * <p/>
+     * </p>
+     * <p>
      * If TMSUSPEND is specified in flags, the transaction branch is temporarily suspended in incomplete state. The
      * transaction context is in suspened state and must be resumed via start with TMRESUME specified.
-     * <p/>
+     * </p>
+     * <p>
      * If TMFAIL is specified, the portion of work has failed. The resource manager may mark the transaction as
      * rollback-only
-     * <p/>
+     * </p>
+     * <p>
      * If TMSUCCESS is specified, the portion of work has completed successfully.
+     * </p>
      *
      * @param xid   A global transaction identifier that is the same as what was used previously in the start method.
      * @param flags One of TMSUCCESS, TMFAIL, or TMSUSPEND

Modified: db/derby/code/trunk/java/org.apache.derby.commons/org/apache/derby/shared/common/drda/NaiveTrustManager.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.commons/org/apache/derby/shared/common/drda/NaiveTrustManager.java?rev=1833280&r1=1833279&r2=1833280&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.commons/org/apache/derby/shared/common/drda/NaiveTrustManager.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.commons/org/apache/derby/shared/common/drda/NaiveTrustManager.java Sun Jun 10 14:54:50 2018
@@ -56,6 +56,18 @@ public class NaiveTrustManager
      * Generate a socket factory with this trust manager. Derby
      * Utility routine which is not part of the X509TrustManager
      * interface.
+     *
+     * @param sslProperties Configuration settings for the socket factory
+     *
+     * @return a socket factory
+     *
+     * @throws java.security.NoSuchAlgorithmException on error
+     * @throws java.security.KeyManagementException on error
+     * @throws java.security.NoSuchProviderException on error
+     * @throws java.security.KeyStoreException on error
+     * @throws java.security.UnrecoverableKeyException on error
+     * @throws java.security.cert.CertificateException on error
+     * @throws java.io.IOException on error
      **/
     public static SocketFactory getSocketFactory(Properties sslProperties)
         throws java.security.NoSuchAlgorithmException,

Modified: db/derby/code/trunk/java/org.apache.derby.commons/org/apache/derby/shared/common/error/ErrorStringBuilder.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.commons/org/apache/derby/shared/common/error/ErrorStringBuilder.java?rev=1833280&r1=1833279&r2=1833280&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.commons/org/apache/derby/shared/common/error/ErrorStringBuilder.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.commons/org/apache/derby/shared/common/error/ErrorStringBuilder.java Sun Jun 10 14:54:50 2018
@@ -40,6 +40,8 @@ public class ErrorStringBuilder
 
 	/**
 	** Construct an error string builder
+    *
+    * @param headerGetter A header getter
 	*/
 	public ErrorStringBuilder(PrintWriterGetHeader headerGetter)
 	{
@@ -119,6 +121,8 @@ public class ErrorStringBuilder
 
 	/**
 	** Get the buffer
+    *
+    * @return an evolving string builder
 	*/
 	public StringBuffer get()
 	{

Modified: db/derby/code/trunk/java/org.apache.derby.commons/org/apache/derby/shared/common/error/MessageUtils.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.commons/org/apache/derby/shared/common/error/MessageUtils.java?rev=1833280&r1=1833279&r2=1833280&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.commons/org/apache/derby/shared/common/error/MessageUtils.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.commons/org/apache/derby/shared/common/error/MessageUtils.java Sun Jun 10 14:54:50 2018
@@ -210,6 +210,10 @@ public class MessageUtils
      * Hash function to split messages into 50 files based upon the message identifier 
      * or SQLState. We don't use String.hashCode() as it varies between releases and 
      * doesn't provide an even distribution across the 50 files.
+     *
+     * @param key The key to hash
+     *
+     * @return the resulting hash
      */
     public static int hashString50(String key) {
 		int hash = 0;
@@ -288,6 +292,11 @@ public class MessageUtils
      *                   arguments) plus messageId, separated by separator.
      * @param sqlerrp    not used
      * @param errd0      not used
+     * @param errd1      not used
+     * @param errd2      not used
+     * @param errd3      not used
+     * @param errd4      not used
+     * @param errd5      not used
      * @param warn       not used
      * @param sqlState   5-char sql state
      * @param file       not used
@@ -356,6 +365,8 @@ public class MessageUtils
      * @param locale     locale
      * @param messageId  message id
      * @param args       message arguments
+     *
+     * @return the localized message
      */
     public static String getLocalizedMessage(Locale locale, String messageId, Object [] args)
     {

Modified: db/derby/code/trunk/java/org.apache.derby.commons/org/apache/derby/shared/common/error/PublicAPI.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.commons/org/apache/derby/shared/common/error/PublicAPI.java?rev=1833280&r1=1833279&r2=1833280&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.commons/org/apache/derby/shared/common/error/PublicAPI.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.commons/org/apache/derby/shared/common/error/PublicAPI.java Sun Jun 10 14:54:50 2018
@@ -33,6 +33,10 @@ public class PublicAPI
 	/**
 		Generates a SQLException for signalling that the
 		operation failed due to a database error.
+
+        @param se The exception to wrap inside a SQLException
+
+        @return a SQLException wrapped around the original exception
 	 */
 	public static SQLException wrapStandardException(StandardException se) {
         se.markAsPublicAPI();

Modified: db/derby/code/trunk/java/org.apache.derby.commons/org/apache/derby/shared/common/error/StandardException.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.commons/org/apache/derby/shared/common/error/StandardException.java?rev=1833280&r1=1833279&r2=1833280&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.commons/org/apache/derby/shared/common/error/StandardException.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.commons/org/apache/derby/shared/common/error/StandardException.java Sun Jun 10 14:54:50 2018
@@ -119,6 +119,8 @@ public class StandardException extends E
 	/**
 		Yes, report me. Errors that need this method to return
 		false are in the minority.
+
+        @return the report type
 	*/
 	public final int report() {
 		return report;
@@ -126,6 +128,8 @@ public class StandardException extends E
 
 	/**
 		Set my report type.
+
+        @param report The report type
 	*/
 	public final void setReport(int report) {
 		this.report = report;
@@ -149,6 +153,8 @@ public class StandardException extends E
 		If you need teh identifier that was used to create the
 		message, then use getMessageId(). getMessageId() will return the
 		string that corresponds to the field in org.apache.derby.shared.common.reference.SQLState.
+
+        @return the 5 character SQL state
 	*/
 	public final String getSQLState()
 	{
@@ -191,7 +197,10 @@ public class StandardException extends E
 
 	/**
 		Get the severity given a message identifier from org.apache.derby.shared.common.reference.SQLState.
-	*/
+
+        @param messageID The handle on the message
+        @return the severity associated with the message
+    */
 	public static int getSeverityFromIdentifier(String messageID) {
 
 		int lseverity = ExceptionSeverity.NO_APPLICABLE_SEVERITY;
@@ -350,6 +359,9 @@ public class StandardException extends E
      *        <b>It is the caller's responsibility to ensure that this message is properly localized.</b>
      *
      * See org.apache.derby.iapi.tools.i18n.LocalizedResource
+     *
+     *
+     * @return a Derby exception
      */
     public static StandardException newPreLocalizedException( String MessageID,
                                                               Throwable t,
@@ -364,7 +376,12 @@ public class StandardException extends E
     
 	/**
      * Unpack the exception, looking for a StandardException, which carries
-	 * the Derby messageID and arguments. 
+	 * the Derby messageID and arguments.
+     *
+     * @param se A SQLException
+     *
+     * @return a Derby exception wrapping the contents of the SQLException
+     *
 	 * @see org.apache.derby.impl.jdbc.SQLExceptionFactory
 	 * @see org.apache.derby.impl.jdbc.Util
 	 */
@@ -515,6 +532,10 @@ public class StandardException extends E
 		Similar to unexpectedUserException but makes no assumtion about
 		when the execption is being called. The error is wrapped as simply
 		as possible.
+
+        @param t The original error which should be wrapped
+
+        @return a Derby exception which wraps the original error
 	*/
 
 	public static StandardException plainWrapException(Throwable t) {
@@ -559,6 +580,8 @@ public class StandardException extends E
 
 	/**
 	** A special exception to close a session.
+    *
+    * @return a "session close" exception
 	*/
 	public static StandardException closeException() {
 		StandardException se = newException(SQLState.CLOSE_REQUEST);
@@ -570,18 +593,22 @@ public class StandardException extends E
 	*/
 
 	/**
+        <P>
 		The message stored in the super class Throwable must be set
 		up object creation. At this time we cannot get any information
 		about the object itself (ie. this) in order to determine the
 		natural language message. Ie. we need to class of the objec in
 		order to look up its message, but we can't get the class of the
 		exception before calling the super class message.
+		</P>
 		<P>
 		Thus the message stored by Throwable and obtained by the
 		getMessage() of Throwable (ie. super.getMessage() in this
 		class) is the message identifier. The actual text message
 		is stored in this class at the first request.
+		</P>
 
+        @return the message text
 	*/
 
 	public String getMessage() {
@@ -596,6 +623,8 @@ public class StandardException extends E
 	/**
 		Return the message identifier that is used to look up the
 		error message text in the messages.properties file.
+
+        @return the message id
 	*/
 	public final String getMessageId() {
 		return super.getMessage();
@@ -606,6 +635,9 @@ public class StandardException extends E
 		Get the error code for an error given a type. The value of
 		the property messageId.type will be returned, e.g.
 		deadlock.sqlstate.
+
+        @param type An error type
+        @return the corresponding error code
 	*/
 	public String getErrorProperty(String type) {
 		return getErrorProperty(getMessageId(), type);

Modified: db/derby/code/trunk/java/org.apache.derby.commons/org/apache/derby/shared/common/i18n/BundleFinder.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.commons/org/apache/derby/shared/common/i18n/BundleFinder.java?rev=1833280&r1=1833279&r2=1833280&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.commons/org/apache/derby/shared/common/i18n/BundleFinder.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.commons/org/apache/derby/shared/common/i18n/BundleFinder.java Sun Jun 10 14:54:50 2018
@@ -33,6 +33,8 @@ public interface BundleFinder {
 		of the messages file.
 
 		@param msgId Message being searched for.
+
+        @return the corresponding message bundle
 	*/
 	ResourceBundle getBundle(String msgId);
 }

Modified: db/derby/code/trunk/java/org.apache.derby.commons/org/apache/derby/shared/common/i18n/LocaleFinder.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.commons/org/apache/derby/shared/common/i18n/LocaleFinder.java?rev=1833280&r1=1833279&r2=1833280&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.commons/org/apache/derby/shared/common/i18n/LocaleFinder.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.commons/org/apache/derby/shared/common/i18n/LocaleFinder.java Sun Jun 10 14:54:50 2018
@@ -32,6 +32,9 @@ import java.text.DateFormat;
 public interface LocaleFinder {
 
 	/**
+     *
+     * @return the current locale
+     *
 	 * @exception StandardException		Thrown on error
 	 */
 	Locale getCurrentLocale() throws StandardException;
@@ -40,6 +43,8 @@ public interface LocaleFinder {
 	 * Get a formatter for formatting dates. The implementation may cache this
 	 * value, since it never changes for a given Locale.
 	 *
+     * @return the date formatter used for this locale
+     * 
 	 * @exception StandardException		Thrown on error
 	 */
 	DateFormat getDateFormat() throws StandardException;
@@ -47,6 +52,8 @@ public interface LocaleFinder {
 	/**
 	 * Get a formatter for formatting times. The implementation may cache this
 	 * value, since it never changes for a given Locale.
+     *
+     * @return the time formatter used for this locale
 	 *
 	 * @exception StandardException		Thrown on error
 	 */
@@ -57,6 +64,8 @@ public interface LocaleFinder {
 	 * Get a formatter for formatting timestamps. The implementation may cache
 	 * this value, since it never changes for a given Locale.
 	 *
+     * @return the timestamp formatter used for this locale
+     *
 	 * @exception StandardException		Thrown on error
 	 */
 	DateFormat getTimestampFormat() throws StandardException;

Modified: db/derby/code/trunk/java/org.apache.derby.commons/org/apache/derby/shared/common/i18n/MessageService.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.commons/org/apache/derby/shared/common/i18n/MessageService.java?rev=1833280&r1=1833279&r2=1833280&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.commons/org/apache/derby/shared/common/i18n/MessageService.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.commons/org/apache/derby/shared/common/i18n/MessageService.java Sun Jun 10 14:54:50 2018
@@ -64,14 +64,21 @@ public final class MessageService {
 	}
 
 	/**
+	  <P>
 	  Transform the message from messageID to the actual error, warning, or
 	  info message using the correct locale.
+	  </P>
 
 	  <P>
 	  The arguments to the messages are passed via an object array, the objects
 	  in the array WILL be changed by this class. The caller should NOT get the
 	  object back from this array.
+	  </P>
+
+      @param messageId The message handle
+      @param arguments The arguments to the message
 
+      @return the text for the message with arguments plugged in
 	 */
     public static String getTextMessage(String messageId, Object... arguments) {
 		try {
@@ -87,6 +94,12 @@ public final class MessageService {
 
 
 	/**
+     * Append a property name onto the end of a message
+     *
+     * @param messageId The handle on the message
+     * @param propertyName The property to append
+     *
+     * @return the resulting new property name
 	 */
 	public static String getProperty(String messageId, String propertyName) {
 
@@ -178,6 +191,11 @@ public final class MessageService {
 		This method acts like ResourceBundle.getBundle() but if
 		the resource is not available in the requested locale,
 		default locale or base class the one for en_US is returned.
+
+        @param resource The name of the message resource
+        @param locale The preferred locale
+
+        @return the best message bundle to localize the messages
 	*/
 	public static ResourceBundle getBundleWithEnDefault(String resource, Locale locale)
     {
@@ -273,6 +291,8 @@ public final class MessageService {
 		String.hashCode() as it varies between releases and
 		doesn't provide an even distribution across the 50 files.
 
+        @param key A key to hash
+        @return the corresponding hash
 	*/
 	public static int hashString50(String key) {
 		int hash = 0;

Modified: db/derby/code/trunk/java/org.apache.derby.commons/org/apache/derby/shared/common/i18n/MessageUtil.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.commons/org/apache/derby/shared/common/i18n/MessageUtil.java?rev=1833280&r1=1833279&r2=1833280&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.commons/org/apache/derby/shared/common/i18n/MessageUtil.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.commons/org/apache/derby/shared/common/i18n/MessageUtil.java Sun Jun 10 14:54:50 2018
@@ -58,6 +58,11 @@ public class MessageUtil
     
     /**
      * Get a message with default locale.
+     *
+     * @param messageID The message handle
+     * @param args The arguments to plug into the message
+     *
+     * @return the message text with arguments plugged in
      */
     public String getTextMessage(String messageID, Object... args) {
         return getCompleteMessage(messageID, args);
@@ -70,6 +75,11 @@ public class MessageUtil
      *
      * If for some reason the message could not be found, we return a
      * default message using the message arguments
+     *
+     * @param messageID The message handle
+     * @param args The arguments to plug into the message
+     *
+     * @return the message text with arguments plugged in
      */
     public String getCompleteMessage(String messageID, Object[] args)
     {
@@ -152,6 +162,8 @@ public class MessageUtil
      * 
      * @param arguments
      *      The arguments to the message
+     *
+     * @return the message text
      */
     public static String getCompleteMessage(String messageId,
         String resourceBundleName, Object[] arguments) 
@@ -188,6 +200,8 @@ public class MessageUtil
      *      If composeDefault is true, then if the message id is not found in
      *      the given bundle, this method composes and returns as helpful a 
      *      message as possible in the format "UNKNOWN : [arg1], [arg2], ..."
+     *
+     * @return the formatted message text
      */
     public static String formatMessage(ResourceBundle bundle, String messageId, 
         Object[] arguments, boolean composeDefault) {
@@ -274,7 +288,9 @@ public class MessageUtil
      *      The message to start with, which often is null
      *
      * @param arguments
-     *      The arguments to the message.  
+     *      The arguments to the message.
+     *
+     * @return formatted message text
      */
     public static String composeDefaultMessage(String message, Object[] arguments)
     {

Modified: db/derby/code/trunk/java/org.apache.derby.commons/org/apache/derby/shared/common/info/JVMInfo.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.commons/org/apache/derby/shared/common/info/JVMInfo.java?rev=1833280&r1=1833279&r2=1833280&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.commons/org/apache/derby/shared/common/info/JVMInfo.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.commons/org/apache/derby/shared/common/info/JVMInfo.java Sun Jun 10 14:54:50 2018
@@ -128,6 +128,8 @@ public abstract class JVMInfo
 
 	/**
 		Return Derby's understanding of the virtual machine's environment.
+
+        @return a string description of the virtual machine's version
 	*/
 	public static String derbyVMLevel()
 	{



Mime
View raw message