Merge pull request #1642 from grandinj/javadoc3

update javadoc

h2/src/main/org/h2/command/Parser.java

@@ -6941,7 +6941,7 @@ public class Parser {
     }
 
     /**
-     * Checks the table is the DUAL special table.
+     * Is this the Oracle DUAL table or the IBM/DB2 SYSIBM table?
      *
      * @param tableName table name.
      * @return {@code true} if the table is DUAL special table. Otherwise returns {@code false}.

h2/src/main/org/h2/command/dml/Optimizer.java

@@ -47,7 +47,7 @@ class Optimizer {
     private TableFilter topFilter;
     private double cost;
     private Random random;
-    final AllColumnsForPlan allColumnsSet;
+    private final AllColumnsForPlan allColumnsSet;
 
     Optimizer(TableFilter[] filters, Expression condition, Session session) {
         this.filters = filters;

h2/src/main/org/h2/command/dml/Select.java

@@ -105,6 +105,9 @@ public class Select extends Query {
      */
     boolean[] groupByExpression;
 
+    /**
+     * Grouped data for aggregates.
+     */
     SelectGroups groupData;
 
     private int havingIndex;
@@ -161,6 +164,9 @@ public class Select extends Query {
         this.expressions = expressions;
     }
 
+    /**
+     * Sets a wildcard expression as in "SELECT * FROM TEST".
+     */
     public void setWildcard() {
         expressions = new ArrayList<>(1);
         expressions.add(new Wildcard(null, null));
@@ -201,7 +207,9 @@ public class Select extends Query {
     }
 
     /**
-     * Set the distinct expressions.
+     * Set the DISTINCT ON expressions.
+     * 
+     * @param distinctExpressions array of expressions
      */
     public void setDistinct(Expression[] distinctExpressions) {
         if (distinct) {

h2/src/main/org/h2/command/dml/SelectGroups.java

@@ -195,7 +195,7 @@ public abstract class SelectGroups {
     }
 
     /**
-     * The session.
+     * The database session.
      */
     final Session session;
 

h2/src/main/org/h2/constraint/ConstraintReferential.java

@@ -471,6 +471,9 @@ public class ConstraintReferential extends Constraint {
         buildDeleteSQL();
     }
 
+    /**
+     * Update the constraint SQL when a referenced column is renamed.
+     */
     public void updateOnTableColumnRename() {
         if (deleteAction != null) {
             deleteSQL = null;

h2/src/main/org/h2/engine/Database.java

@@ -1149,6 +1149,10 @@ public class Database implements DataHandler {
         }
     }
 
+    /**
+     * Mark some database ids as unused.
+     * @param idsToRelease the ids to release
+     */
     void releaseDatabaseObjectIds(BitSet idsToRelease) {
         synchronized (objectIds) {
             objectIds.andNot(idsToRelease);

h2/src/main/org/h2/expression/ExpressionColumn.java

@@ -155,6 +155,11 @@ public class ExpressionColumn extends Expression {
         return columnResolver.optimize(this, column);
     }
 
+    /**
+     * Get exception to throw, with column and table info added
+     * @param code SQL error code
+     * @return DbException
+     */
     public DbException getColumnException(int code) {
         String name = columnName;
         if (tableAlias != null) {

h2/src/main/org/h2/expression/function/Function.java

@@ -1141,6 +1141,16 @@ public class Function extends Expression implements FunctionCall {
         return new Parser(session).parseTableName(tableName.getString());
     }
 
+    /**
+     * Get value transformed by expression, or null if i is out of range or
+     * the input value is null.
+     * 
+     * @param session database session
+     * @param args expressions
+     * @param values array of input values
+     * @param i index of value of transform
+     * @return value or null
+     */
     protected static Value getNullOrValue(Session session, Expression[] args,
             Value[] values, int i) {
         if (i >= args.length) {

h2/src/main/org/h2/message/DbException.java

@@ -56,7 +56,7 @@ public class DbException extends RuntimeException {
     private static final Properties MESSAGES = new Properties();
 
     /**
-     * Thrown when OOME exception is happened on handle error
+     * Thrown when OOME exception happens on handle error
      * inside {@link #convert(java.lang.Throwable)}.
      */
     public static final SQLException SQL_OOME =

h2/src/main/org/h2/mvstore/tx/Transaction.java

@@ -64,6 +64,10 @@ public class Transaction {
     private static final String[] STATUS_NAMES = {
             "CLOSED", "OPEN", "PREPARED", "COMMITTED", "ROLLING_BACK", "ROLLED_BACK"
     };
+    /**
+     * How many bits of the "operation id" we store in the transaction belong to the
+     * log id (the rest belong to the transaction id).
+     */
     static final int LOG_ID_BITS = 40;
     private static final int LOG_ID_BITS1 = LOG_ID_BITS + 1;
     private static final long LOG_ID_LIMIT = 1L << LOG_ID_BITS;

h2/src/main/org/h2/table/Plan.java

@@ -102,6 +102,7 @@ public class Plan {
      * Calculate the cost of this query plan.
      *
      * @param session the session
+     * @param allColumnsSet calculates all columns on-demand
      * @return the cost
      */
     public double calculateCost(Session session, AllColumnsForPlan allColumnsSet) {

h2/src/main/org/h2/tools/Console.java

@@ -255,6 +255,9 @@ public class Console extends Tool implements ShutdownHandler {
         }
     }
 
+    /**
+     * Overridden by GUIConsole to show a window
+     */
     void show() {
     }
 
@@ -287,6 +290,11 @@ public class Console extends Tool implements ShutdownHandler {
         }
     }
 
+    /**
+     * Open a new browser tab or window with the given URL.
+     *
+     * @param url the URL to open
+     */
     void openBrowser(String url) {
         try {
             Server.openBrowser(url);

h2/src/main/org/h2/util/IntervalUtils.java

@@ -328,7 +328,7 @@ public class IntervalUtils {
         return ValueInterval.from(qualifier, negative, leading, remaining);
     }
 
-    static ValueInterval parseInterval2(IntervalQualifier qualifier, String s, char ch, int max, boolean negative) {
+    private static ValueInterval parseInterval2(IntervalQualifier qualifier, String s, char ch, int max, boolean negative) {
         long leading;
         long remaining;
         int dash = s.indexOf(ch, 1);

h2/src/main/org/h2/util/StringUtils.java

@@ -172,6 +172,15 @@ public class StringUtils {
         return buff.toString();
     }
 
+    /**
+     * Convert a string to a Java literal using the correct escape sequences.
+     * The literal is not enclosed in double quotes. The result can be used in
+     * properties files or in Java source code.
+     * 
+     * @param s the text to convert
+     * @param buff the Java representation to return
+     * @param forSQL true if we embedding this inside a STRINGDECODE SQL command
+     */
     public static void javaEncode(String s, StringBuilder buff, boolean forSQL) {
         int length = s.length();
         for (int i = 0; i < length; i++) {

h2/src/main/org/h2/util/geometry/GeometryUtils.java

@@ -167,7 +167,7 @@ public final class GeometryUtils {
          */
         private boolean set;
 
-        double minX, maxX, minY, maxY;
+        private double minX, maxX, minY, maxY;
 
         /**
          * Creates a new envelope calculation target.
@@ -295,7 +295,7 @@ public final class GeometryUtils {
          */
         private boolean set;
 
-        double minX, maxX, minY, maxY;
+        private double minX, maxX, minY, maxY;
 
         private boolean hasZ;
 
@@ -567,6 +567,11 @@ public final class GeometryUtils {
         return Double.isNaN(d) ? Double.NaN : d == 0d ? 0d : d;
     }
 
+    /**
+     * Throw exception if param is not finite value (ie. NaN/inf/etc)
+     * @param d double value
+     * @return same double value
+     */
     static double checkFinite(double d) {
         // Do not push this negation down, it will break NaN rejection
         if (!(Math.abs(d) <= Double.MAX_VALUE)) {

h2/src/main/org/h2/util/geometry/JTSUtils.java

@@ -56,6 +56,9 @@ public final class JTSUtils {
      */
     public static final boolean M_IS_SUPPORTED;
 
+    /**
+     * create(int,int,int) method from CoordinateSequenceFactory, if it exists
+     */
     static final Method CREATE;
 
     private static final Method GET_MEASURES;

h2/src/main/org/h2/value/ExtTypeInfoEnum.java

@@ -132,6 +132,11 @@ public final class ExtTypeInfoEnum extends ExtTypeInfo {
         return enumerators[ordinal];
     }
 
+    /**
+     * Get ValueEnum instance for an ordinal.
+     * @param ordinal ordinal value of an enum
+     * @return ValueEnum instance
+     */
     public ValueEnum getValue(int ordinal) {
         if (ordinal < 0 || ordinal >= enumerators.length) {
             throw DbException.get(ErrorCode.ENUM_VALUE_NOT_PERMITTED, enumerators.toString(),
@@ -140,6 +145,11 @@ public final class ExtTypeInfoEnum extends ExtTypeInfo {
         return new ValueEnum(this, enumerators[ordinal], ordinal);
     }
 
+    /**
+     * Get ValueEnum instance for a label string.
+     * @param label label string
+     * @return ValueEnum instance
+     */
     public ValueEnum getValue(String label) {
         ValueEnum value = getValueOrNull(label);
         if (value == null) {

h2/src/main/org/h2/value/Value.java

@@ -1496,7 +1496,7 @@ public abstract class Value extends VersionedValue {
     }
 
     /**
-     * Checks value by Integer type numeric range.
+     * Convert to integer, throwing exception if out of range.
      *
      * @param x integer value.
      * @param column Column info.

h2/src/main/org/h2/value/ValueInterval.java

@@ -53,8 +53,8 @@ public class ValueInterval extends Value {
     private final long remaining;
 
     /**
-     * Creates interval value.
-     *
+     * Create a ValueInterval instance.
+     * 
      * @param qualifier
      *            qualifier
      * @param negative
@@ -82,7 +82,7 @@ public class ValueInterval extends Value {
      * @param scale
      *            fractional seconds precision. Ignored if specified type of
      *            interval does not have seconds.
-     * @return displayed size.
+     * @return display size
      */
     public static int getDisplaySize(int type, int precision, int scale) {
         switch (type) {

h2/src/test/org/h2/test/db/TestAnalyzeTableTx.java

@@ -12,7 +12,7 @@ import java.sql.ResultSet;
 import java.sql.Statement;
 
 public class TestAnalyzeTableTx extends TestDb {
-    static final int C = 10_000;
+    private static final int C = 10_000;
 
     /**
      * Run just this test.