Spellchecking, javadocs, formatting

h2/src/main/org/h2/api/JavaObjectSerializer.java

@@ -7,7 +7,8 @@
 package org.h2.api;
 
 /**
- * Custom serialization mechanism for java objects being stored in column of type OTHER.
+ * Custom serialization mechanism for java objects being stored in column of
+ * type OTHER.
  *
  * @author Sergi Vladykin
  */
@@ -16,15 +17,15 @@ public interface JavaObjectSerializer {
     /**
      * Serialize object to byte array.
      *
-     * @param obj
-     * @return the byte array
+     * @param obj the object to serialize
+     * @return the byte array of the serialized object
      */
     byte[] serialize(Object obj) throws Exception;
 
     /**
      * Deserialize object from byte array.
      *
-     * @param bytes
+     * @param bytes the byte array of the serialized object
      * @return the object
      */
     Object deserialize(byte[] bytes) throws Exception;

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

@@ -190,7 +190,7 @@ public class ScriptCommand extends ScriptBase {
                 Constant constant = (Constant) obj;
                 add(constant.getCreateSQL(), false);
             }
-            
+
             final ArrayList<Table> tables = db.getAllTablesAndViews(false);
             // sort by id, so that views are after tables and views on views
             // after the base views
@@ -199,8 +199,8 @@ public class ScriptCommand extends ScriptBase {
                     return t1.getId() - t2.getId();
                 }
             });
-            
-            // Generate the DROP XXX  ... IF EXISTS 
+
+            // Generate the DROP XXX  ... IF EXISTS
             for (Table table : tables) {
                 if (excludeSchema(table.getSchema())) {
                     continue;
@@ -246,8 +246,8 @@ public class ScriptCommand extends ScriptBase {
                 }
                 add(sequence.getCreateSQL(), false);
             }
-            
-            // Generate CREATE TABLE and INSERT...VALUES 
+
+            // Generate CREATE TABLE and INSERT...VALUES
             int count = 0;
             for (Table table : tables) {
                 if (excludeSchema(table.getSchema())) {
@@ -333,7 +333,7 @@ public class ScriptCommand extends ScriptBase {
                 }
                 add(trigger.getCreateSQL(), false);
             }
-            // Generate GRANT ... 
+            // Generate GRANT ...
             for (Right right : db.getAllRights()) {
                 Table table = right.getGrantedTable();
                 if (table != null) {
@@ -346,7 +346,7 @@ public class ScriptCommand extends ScriptBase {
                 }
                 add(right.getCreateSQL(), false);
             }
-            // Generate COMMENT ON ... 
+            // Generate COMMENT ON ...
             for (Comment comment : db.getAllComments()) {
                 add(comment.getCreateSQL(), false);
             }

h2/src/main/org/h2/constant/SysProperties.java

@@ -399,8 +399,9 @@ public class SysProperties {
 
     /**
      * System property <code>h2.javaObjectSerializer</code> (default: null).<br />
-     * The JavaObjectSerializer class name for java objects being stored in column of type OTHER.
-     * It must be the same on client and server to work correctly.
+     * The JavaObjectSerializer class name for java objects being stored in
+     * column of type OTHER. It must be the same on client and server to work
+     * correctly.
      */
     public static final String JAVA_OBJECT_SERIALIZER = Utils.getProperty("h2.javaObjectSerializer", null);
 

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

@@ -143,5 +143,5 @@ public class MetaRecord implements Comparable<MetaRecord> {
     public String toString() {
         return "MetaRecord [id=" + id + ", objectType=" + objectType + ", sql=" + sql + "]";
     }
-    
+
 }

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

@@ -19,10 +19,11 @@ import org.h2.value.ValueBoolean;
 import org.h2.value.ValueNull;
 
 /**
- * Used for optimised IN(...) queries where the contents of the IN list are all constant and of the same type.
+ * Used for optimised IN(...) queries where the contents of the IN list are all
+ * constant and of the same type.
  * <p>
- * Checking using a HashSet is has time complexity O(1), instead of O(n) for checking using
- * an array.
+ * Checking using a HashSet is has time complexity O(1), instead of O(n) for
+ * checking using an array.
  */
 public class ConditionInConstantSet extends Condition {
 
@@ -30,10 +31,11 @@ public class ConditionInConstantSet extends Condition {
     private int queryLevel;
     private final ArrayList<Expression> valueList;
     private final HashSet<Value> valueSet;
-    
+
     /**
      * Create a new IN(..) condition.
      *
+     * @param session the session
      * @param left the expression before IN
      * @param valueList the value list (at least two elements)
      */
@@ -55,7 +57,7 @@ public class ConditionInConstantSet extends Condition {
         Value firstRightVal = valueSet.iterator().next();
         leftVal = leftVal.convertTo(firstRightVal.getType());
         boolean result = valueSet.contains(leftVal);
-        
+
         if (!result && setHasNull) {
             return ValueNull.INSTANCE;
         }

h2/src/main/org/h2/res/help.csv

@@ -1016,7 +1016,7 @@ CONCAT(string, string [,...])
 ","
 Combines strings."
 "Functions (String)","CONCAT_WS","
-CONCAT_WS(string, string, string [,...])
+CONCAT_WS(separatorString, string, string [,...])
 ","
 Combines strings with separator."
 "Functions (String)","DIFFERENCE","

h2/src/main/org/h2/store/PageStore.java

@@ -1710,8 +1710,8 @@ public class PageStore implements CacheWriter {
         Table table = index.getTable();
         if (SysProperties.CHECK) {
             if (!table.isTemporary()) {
-                /* To prevent ABBA locking problems, we need to always take the Database lock before we take the
-                 * PageStore lock. */
+                // to prevent ABBA locking problems, we need to always take
+                // the Database lock before we take the PageStore lock
                 synchronized (database) {
                     synchronized (this) {
                         database.verifyMetaLocked(session);
@@ -1764,8 +1764,8 @@ public class PageStore implements CacheWriter {
     public void removeMeta(Index index, Session session) {
         if (SysProperties.CHECK) {
             if (!index.getTable().isTemporary()) {
-                /* To prevent ABBA locking problems, we need to always take the Database lock before we take the
-                 * PageStore lock. */
+                // to prevent ABBA locking problems, we need to always take
+                // the Database lock before we take the PageStore lock
                 synchronized (database) {
                     synchronized (this) {
                         database.verifyMetaLocked(session);

h2/src/main/org/h2/store/fs/FilePathMem.java

@@ -216,7 +216,11 @@ class FilePathMemLZF extends FilePathMem {
  */
 class FileMem extends FileBase {
 
+    /**
+     * The file data.
+     */
     final FileMemData data;
+
     private final boolean readOnly;
     private long pos;
 
@@ -352,6 +356,11 @@ class FileMemData {
         lastModified = System.currentTimeMillis();
     }
 
+    /**
+     * Lock the file in exclusive mode if possible.
+     *
+     * @return if locking was successful
+     */
     synchronized boolean lockExclusive() {
         if (sharedLockCount > 0 || isLockedExclusive) {
             return false;
@@ -360,6 +369,11 @@ class FileMemData {
         return true;
     }
 
+    /**
+     * Lock the file in shared mode if possible.
+     *
+     * @return if locking was successful
+     */
     synchronized boolean lockShared() {
         if (isLockedExclusive) {
             return false;
@@ -368,6 +382,9 @@ class FileMemData {
         return true;
     }
 
+    /**
+     * Unlock the file.
+     */
     synchronized void unlock() {
         if (isLockedExclusive) {
             isLockedExclusive = false;

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

@@ -47,7 +47,8 @@ public class TableView extends Table {
     private ViewIndex index;
     private boolean recursive;
     private DbException createException;
-    private final SmallLRUCache<IntArray, ViewIndex> indexCache = SmallLRUCache.newInstance(Constants.VIEW_INDEX_CACHE_SIZE);
+    private final SmallLRUCache<IntArray, ViewIndex> indexCache =
+            SmallLRUCache.newInstance(Constants.VIEW_INDEX_CACHE_SIZE);
     private long lastModificationCheck;
     private long maxDataModificationId;
     private User owner;

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

@@ -31,6 +31,9 @@ import org.h2.message.DbException;
  */
 public class Utils {
 
+    /**
+     * The serializer to use.
+     */
     public static JavaObjectSerializer serializer;
 
     /**

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

@@ -321,7 +321,7 @@ public class TestOptimizations extends TestBase {
 
         conn.close();
     }
-    
+
     private void testNestedInSelect() throws SQLException {
         deleteDb("optimizations");
         Connection conn = getConnection("optimizations");

h2/src/test/org/h2/test/jdbc/TestStatement.java

@@ -335,7 +335,7 @@ public class TestStatement extends TestBase {
         rs.next();
         assertEquals(7, rs.getInt(1));
         assertFalse(rs.next());
-        
+
         stat.execute("CREATE TABLE TEST2(ID identity primary key)");
         stat.execute("INSERT INTO TEST2 VALUES()");
         stat.execute("SET @X = IDENTITY()");

h2/src/test/org/h2/test/store/TestStreamStore.java

@@ -47,7 +47,7 @@ public class TestStreamStore extends TestBase {
         testLoop();
     }
 
-    public void testDetectIllegalId() throws IOException {
+    private void testDetectIllegalId() throws IOException {
         Map<Long, byte[]> map = New.hashMap();
         StreamStore store = new StreamStore(map);
         try {
@@ -72,7 +72,7 @@ public class TestStreamStore extends TestBase {
         }
     }
 
-    public void testTreeStructure() throws IOException {
+    private void testTreeStructure() throws IOException {
 
         final AtomicInteger reads = new AtomicInteger();
         Map<Long, byte[]> map = new HashMap<Long, byte[]>() {
@@ -95,7 +95,7 @@ public class TestStreamStore extends TestBase {
         assertEquals(3, reads.get());
     }
 
-    public void testFormat() throws IOException {
+    private void testFormat() throws IOException {
         Map<Long, byte[]> map = New.hashMap();
         StreamStore store = new StreamStore(map);
         store.setMinBlockSize(10);
@@ -128,7 +128,7 @@ public class TestStreamStore extends TestBase {
         assertEquals(1, in.skip(1));
     }
 
-    public void testWithExistingData() throws IOException {
+    private void testWithExistingData() throws IOException {
 
         final AtomicInteger tests = new AtomicInteger();
         Map<Long, byte[]> map = new HashMap<Long, byte[]>() {
@@ -170,7 +170,7 @@ public class TestStreamStore extends TestBase {
         }
     }
 
-    public void testWithFullMap() throws IOException {
+    private void testWithFullMap() throws IOException {
         final AtomicInteger tests = new AtomicInteger();
         Map<Long, byte[]> map = new HashMap<Long, byte[]>() {
 
@@ -196,7 +196,7 @@ public class TestStreamStore extends TestBase {
         assertEquals(Long.MAX_VALUE / 2 + 1, store.getNextKey());
     }
 
-    public void testLoop() throws IOException {
+    private void testLoop() throws IOException {
         Map<Long, byte[]> map = New.hashMap();
         StreamStore store = new StreamStore(map);
         assertEquals(256 * 1024, store.getMaxBlockSize());

h2/src/tools/org/h2/build/doc/SpellChecker.java

@@ -33,8 +33,16 @@ public class SpellChecker {
     private static final String PREFIX_IGNORE = "abc";
     private static final String[] IGNORE_FILES = {"mainWeb.html", "pg_catalog.sql"};
 
-    // these are public so we can set them during development testing
+    // These are public so we can set them during development testing
+
+    /**
+     * Whether debugging is enabled.
+     */
     public boolean debug;
+
+    /**
+     * Whether to print the dictionary.
+     */
     public boolean printDictionary;
 
     private final HashSet<String> dictionary = new HashSet<String>();

h2/src/tools/org/h2/build/doc/dictionary.txt

@@ -714,10 +714,9 @@ derive bounding greatly extreme terribly iterating pruned percentage
 apart render cloned costly antialiasing antialias quercus rect mvr retina
 sonatype deployed uffff bhat prashant doug lea retained inefficient segments
 segment supplemental adjust evenly pick diehard mixes avalanche candidates
-edition voytovych intersecting cow absent hickey fluid chen qian liberal 
-richard viktor structured continuous inherent kyoto contends abba optimised 
-rollbacks overtaking trivial mutation pitest rectangle uncommon deltas 
-purely intersection obviously cabinet berkeley configurable modular locality 
+edition voytovych intersecting cow absent hickey fluid chen qian liberal
+richard viktor structured continuous inherent kyoto contends abba optimised
+rollbacks overtaking trivial mutation pitest rectangle uncommon deltas
+purely intersection obviously cabinet berkeley configurable modular locality
 subsystem persisting pit jdbm bigserial rtree mutationtest serializer feff mvstore
-versioning
- 
+versioning sector survives
\ No newline at end of file

h2/src/tools/org/h2/dev/store/btree/Chunk.java

@@ -71,11 +71,18 @@ public class Chunk {
      */
     long version;
 
-    public Chunk(int id) {
+    Chunk(int id) {
         this.id = id;
     }
 
-    public static Chunk fromHeader(ByteBuffer buff, long start) {
+    /**
+     * Read the header from the byte buffer.
+     *
+     * @param buff the source buffer
+     * @param start the start of the chunk in the file
+     * @return the chunk
+     */
+    static Chunk fromHeader(ByteBuffer buff, long start) {
         if (buff.get() != 'c') {
             throw new RuntimeException("File corrupt");
         }
@@ -95,6 +102,11 @@ public class Chunk {
         return c;
     }
 
+    /**
+     * Write the header.
+     *
+     * @param buff the target buffer
+     */
     void writeHeader(ByteBuffer buff) {
         buff.put((byte) 'c');
         buff.putInt(length);
@@ -137,6 +149,11 @@ public class Chunk {
         return o instanceof Chunk && ((Chunk) o).id == id;
     }
 
+    /**
+     * Get the chunk data as a string.
+     *
+     * @return the string
+     */
     public String asString() {
         return
                 "id:" + id + "," +

h2/src/tools/org/h2/dev/store/btree/Cursor.java

@@ -44,6 +44,12 @@ public class Cursor<K> implements Iterator<K> {
         return current != null;
     }
 
+    /**
+     * Skip over that many entries. This method is relatively fast (for this map
+     * implementation) even if many entries need to be skipped.
+     *
+     * @param n the number of entries to skip
+     */
     public void skip(long n) {
         if (!hasNext()) {
             return;
@@ -64,6 +70,13 @@ public class Cursor<K> implements Iterator<K> {
         throw new UnsupportedOperationException();
     }
 
+    /**
+     * Fetch the next entry that is equal or larger than the given key, starting
+     * from the given page.
+     *
+     * @param p the page to start
+     * @param from the key to search
+     */
     protected void min(Page p, K from) {
         while (true) {
             if (p.isLeaf()) {
@@ -85,6 +98,9 @@ public class Cursor<K> implements Iterator<K> {
         }
     }
 
+    /**
+     * Fetch the next entry if there is one.
+     */
     @SuppressWarnings("unchecked")
     protected void fetchNext() {
         while (pos != null) {

h2/src/tools/org/h2/dev/store/btree/DataUtils.java

@@ -301,6 +301,7 @@ public class DataUtils {
      * has been reached. The buffer is rewind at the end.
      *
      * @param file the file channel
+     * @param pos the absolute position within the file
      * @param dst the byte buffer
      */
     public static void readFully(FileChannel file, long pos, ByteBuffer dst) throws IOException {
@@ -318,6 +319,7 @@ public class DataUtils {
      * Write to a file channel.
      *
      * @param file the file channel
+     * @param pos the absolute position within the file
      * @param src the source buffer
      */
     public static void writeFully(FileChannel file, long pos, ByteBuffer src) throws IOException {

h2/src/tools/org/h2/dev/store/btree/MVMap.java

@@ -54,6 +54,12 @@ public class MVMap<K, V> extends AbstractMap<K, V>
         this.root = Page.createEmpty(this,  -1);
     }
 
+    /**
+     * Open this map with the given store and configuration.
+     *
+     * @param store the store
+     * @param config the configuration
+     */
     public void open(MVStore store, HashMap<String, String> config) {
         this.store = store;
         this.id = Integer.parseInt(config.get("id"));
@@ -450,7 +456,7 @@ public class MVMap<K, V> extends AbstractMap<K, V>
      * Remove all entries, and close the map.
      */
     public void removeMap() {
-        if (!store.isMetaMap(this)) {
+        if (this != store.getMetaMap()) {
             checkWrite();
             root.removeAllRecursive();
             store.removeMap(name);
@@ -492,6 +498,7 @@ public class MVMap<K, V> extends AbstractMap<K, V>
      * Add a key-value pair if it does not yet exist.
      *
      * @param key the key (may not be null)
+     * @param value the new value
      * @return the old value if the key existed, or null otherwise
      */
     public synchronized V putIfAbsent(K key, V value) {
@@ -599,6 +606,11 @@ public class MVMap<K, V> extends AbstractMap<K, V>
         return result;
     }
 
+    /**
+     * Use the new root page from now on.
+     *
+     * @param newRoot the new root page
+     */
     protected void newRoot(Page newRoot) {
         if (root != newRoot) {
             removeUnusedOldVersions();
@@ -907,6 +919,11 @@ public class MVMap<K, V> extends AbstractMap<K, V>
         return m;
     }
 
+    /**
+     * Open a copy of the map in read-only mode.
+     *
+     * @return the opened map
+     */
     protected MVMap<K, V> openReadOnly() {
         MVMap<K, V> m = new MVMap<K, V>(keyType, valueType);
         m.readOnly = true;
@@ -939,6 +956,14 @@ public class MVMap<K, V> extends AbstractMap<K, V>
         return root.getVersion();
     }
 
+    /**
+     * Get the child page count for this page. This is to allow another map
+     * implementation to override the default, in case the last child is not to
+     * be used.
+     *
+     * @param p the page
+     * @return the number of direct children
+     */
     protected int getChildPageCount(Page p) {
         return p.getChildPageCount();
     }
@@ -952,6 +977,11 @@ public class MVMap<K, V> extends AbstractMap<K, V>
         return "btree";
     }
 
+    /**
+     * Get the map metadata as a string.
+     *
+     * @return the string
+     */
     public String asString() {
         StringBuilder buff = new StringBuilder();
         DataUtils.appendMap(buff, "id", id);

h2/src/tools/org/h2/dev/store/btree/MVStore.java

@@ -43,12 +43,14 @@ TODO:
 - support serialization by default
 - build script
 - test concurrent storing in a background thread
-- store store creation in file header, and seconds since creation in chunk header (plus a counter)
-- recovery: keep some old chunks; don't overwritten for 5 minutes (configurable)
+- store store creation in file header, and seconds since creation
+-- in chunk header (plus a counter)
+- recovery: keep some old chunks; don't overwritten
+-- for 5 minutes (configurable)
 - allocate memory with Utils.newBytes and so on
 - unified exception handling
 - concurrent map; avoid locking during IO (pre-load pages)
-- maybe split database into multiple files, to speed up compact operation
+- maybe split database into multiple files, to speed up compact
 - automated 'kill process' and 'power failure' test
 - implement table engine for H2
 - auto-compact from time to time and on close
@@ -56,13 +58,15 @@ TODO:
 - support background writes (concurrent modification & store)
 - limited support for writing to old versions (branches)
 - support concurrent operations (including file I/O)
-- on insert, if the child page is already full, don't load and modify it - split directly (for leaves with 1 entry)
+- on insert, if the child page is already full, don't load and modify it
+-- split directly (for leaves with 1 entry)
 - performance test with encrypting file system
 - possibly split chunk data into immutable and mutable
 - compact: avoid processing pages using a counting bloom filter
 - defragment (re-creating maps, specially those with small pages)
 - write using ByteArrayOutputStream; remove DataType.getMaxLength
-- file header: check formatRead and format (is formatRead needed if equal to format?)
+- file header: check formatRead and format (is formatRead
+-- needed if equal to format?)
 - chunk header: store changed chunk data as row; maybe after the root
 - chunk checksum (header, last page, 2 bytes per page?)
 - allow renaming maps
@@ -70,16 +74,22 @@ TODO:
 - online backup
 - MapFactory is the wrong name (StorePlugin?) or is too flexible: remove?
 - store file "header" at the end of each chunk; at the end of the file
-- is there a better name for the file header, if it's no longer always at the beginning of a file?
-- maybe let a chunk point to possible next chunks (so no fixed location header is needed)
+- is there a better name for the file header,
+-- if it's no longer always at the beginning of a file?
+- maybe let a chunk point to possible next chunks
+-- (so no fixed location header is needed)
 - support stores that span multiple files (chunks stored in other files)
 - triggers (can be implemented with a custom map)
-- store write operations per page (maybe defragment if much different than count)
+- store write operations per page (maybe defragment
+-- if much different than count)
 - r-tree: nearest neighbor search
-- use FileChannel by default (nio file system), but: an interrupt close the FileChannel
-- auto-save temporary data if it uses too much memory, but revert it on startup if needed.
+- use FileChannel by default (nio file system), but:
+-- an interrupt close the FileChannel
+- auto-save temporary data if it uses too much memory,
+-- but revert it on startup if needed.
 - map and chunk metadata: do not store default values
-- support maps without values (non-unique indexes), and maps without keys (counted b-tree)
+- support maps without values (non-unique indexes),
+- and maps without keys (counted b-tree)
 - use a small object cache (StringCache)
 - dump values
 - tool to import / manipulate CSV files
@@ -96,6 +106,10 @@ public class MVStore {
      */
     public static final boolean ASSERT = false;
 
+    /**
+     * The block size (physical sector size) of the disk. The file header is
+     * written twice, one copy in each block, to ensure it survives a crash.
+     */
     static final int BLOCK_SIZE = 4 * 1024;
 
     private final HashMap<String, Object> config;
@@ -192,6 +206,7 @@ public class MVStore {
      *
      * @param version the version
      * @param name the map name
+     * @param template the template map
      * @return the read-only map
      */
     @SuppressWarnings("unchecked")
@@ -326,10 +341,6 @@ public class MVStore {
         mapsChanged.remove(map.getId());
     }
 
-    boolean isMetaMap(MVMap<?, ?> map) {
-        return map == meta;
-    }
-
     private DataType getDataType(Class<?> clazz) {
         if (clazz == String.class) {
             return StringType.INSTANCE;
@@ -351,6 +362,9 @@ public class MVStore {
         mapsChanged.put(map.getId(), map);
     }
 
+    /**
+     * Open the store.
+     */
     void open() {
         meta = new MVMap<String, String>(StringType.INSTANCE, StringType.INSTANCE);
         HashMap<String, String> c = New.hashMap();
@@ -1090,6 +1104,9 @@ public class MVStore {
         return unsavedPageCount;
     }
 
+    /**
+     * Increment the number of unsaved pages.
+     */
     void registerUnsavedPage() {
         unsavedPageCount++;
     }

h2/src/tools/org/h2/dev/store/btree/MVStoreBuilder.java

@@ -75,6 +75,12 @@ public class MVStoreBuilder {
         return set("cacheSize", Integer.toString(mb));
     }
 
+    /**
+     * Use the given data type factory.
+     *
+     * @param factory the data type factory
+     * @return this
+     */
     public MVStoreBuilder with(DataTypeFactory factory) {
         return set("dataTypeFactory", factory);
     }
@@ -94,6 +100,12 @@ public class MVStoreBuilder {
         return DataUtils.appendMap(new StringBuilder(), config).toString();
     }
 
+    /**
+     * Read the configuration from a string.
+     *
+     * @param s the string representation
+     * @return the builder
+     */
     public static MVStoreBuilder fromString(String s) {
         HashMap<String, String> config = DataUtils.parseMap(s);
         MVStoreBuilder builder = new MVStoreBuilder();

h2/src/tools/org/h2/dev/store/btree/Page.java

@@ -94,6 +94,7 @@ public class Page {
      * @param counts the children counts
      * @param totalCount the total number of keys
      * @param sharedFlags which arrays are shared
+     * @param memory the memory used in bytes
      * @return the page
      */
     public static Page create(MVMap<?, ?> map, long version,
@@ -119,8 +120,9 @@ public class Page {
      *
      * @param file the file
      * @param map the map
-     * @param filePos the position in the file
      * @param pos the page position
+     * @param filePos the position in the file
+     * @param fileSize the file size (to avoid reading past EOF)
      * @return the page
      */
     static Page read(FileChannel file, MVMap<?, ?> map,
@@ -414,6 +416,12 @@ public class Page {
         return totalCount;
     }
 
+    /**
+     * Get the descendant counts for the given child.
+     *
+     * @param index the child index
+     * @return the descendant count
+     */
     long getCounts(int index) {
         return counts[index];
     }
@@ -633,6 +641,14 @@ public class Page {
         }
     }
 
+    /**
+     * Read the page from the buffer.
+     *
+     * @param buff the buffer
+     * @param chunkId the chunk id
+     * @param offset the offset within the chunk
+     * @param maxLength the maximum length
+     */
     void read(ByteBuffer buff, int chunkId, int offset, int maxLength) {
         int start = buff.position();
         int pageLength = buff.getInt();

h2/src/tools/org/h2/dev/store/btree/StreamStore.java

@@ -263,6 +263,12 @@ public class StreamStore {
         return new Stream(this, id);
     }
 
+    /**
+     * Get the block.
+     *
+     * @param key the key
+     * @return the block
+     */
     byte[] getBlock(long key) {
         return map.get(key);
     }

h2/src/tools/org/h2/dev/store/rtree/MVRTreeMap.java

@@ -22,7 +22,11 @@ import org.h2.util.New;
  */
 public class MVRTreeMap<V> extends MVMap<SpatialKey, V> {
 
+    /**
+     * The spatial key type.
+     */
     final SpatialType keyType;
+
     private boolean quadraticSplit;
 
     public MVRTreeMap(int dimensions, DataType valueType) {
@@ -30,6 +34,14 @@ public class MVRTreeMap<V> extends MVMap<SpatialKey, V> {
         this.keyType = (SpatialType) getKeyType();
     }
 
+    /**
+     * Create a new map with the given dimensions and value type.
+     *
+     * @param <V> the value type
+     * @param dimensions the number of dimensions
+     * @param valueType the value type
+     * @return the map
+     */
     public static <V> MVRTreeMap<V> create(int dimensions, DataType valueType) {
         return new MVRTreeMap<V>(dimensions, valueType);
     }

h2/src/tools/org/h2/dev/store/rtree/package.html

+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<!--
+Copyright 2004-2011 H2 Group. Multiple-Licensed under the H2 License, Version 1.0,
+and under the Eclipse Public License, Version 1.0
+(http://h2database.com/html/license.html).
+Initial Developer: H2 Group
+-->
+<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
+<head><meta http-equiv="Content-Type" content="text/html;charset=utf-8" /><title>
+Javadoc package documentation
+</title></head><body style="font: 9pt/130% Tahoma, Arial, Helvetica, sans-serif; font-weight: normal;"><p>
+
+An R-tree implementation
+
+</p></body></html>
\ No newline at end of file

h2/src/tools/org/h2/dev/store/type/package.html

+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<!--
+Copyright 2004-2011 H2 Group. Multiple-Licensed under the H2 License, Version 1.0,
+and under the Eclipse Public License, Version 1.0
+(http://h2database.com/html/license.html).
+Initial Developer: H2 Group
+-->
+<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
+<head><meta http-equiv="Content-Type" content="text/html;charset=utf-8" /><title>
+Javadoc package documentation
+</title></head><body style="font: 9pt/130% Tahoma, Arial, Helvetica, sans-serif; font-weight: normal;"><p>
+
+Data types and serialization / deserialization
+
+</p></body></html>
\ No newline at end of file

h2/src/tools/org/h2/jaqu/util/ClassUtils.java

@@ -32,8 +32,8 @@ public class ClassUtils {
 
     @SuppressWarnings("unchecked")
     public static <T> T newObject(Class<T> clazz) {
-        // must create new instances, cannot use methods like Boolean.FALSE, since the caller relies
-        // on this creating unique objects
+        // must create new instances, cannot use methods like Boolean.FALSE,
+        // since the caller relies on this creating unique objects
         if (clazz == Integer.class) {
             return (T) new Integer((int) COUNTER.getAndIncrement());
         } else if (clazz == String.class) {