make javadoc happier

andreitokar · andreitokar · commit 36e790d6e0c5 · 2022-01-16T13:47:26.000-05:00
diff --git a/h2/src/main/org/h2/bnf/context/DbProcedure.java b/h2/src/main/org/h2/bnf/context/DbProcedure.java
@@ -71,6 +71,7 @@ public boolean isReturnsResult() {
      * Read the column for this table from the database meta data.
      *
      * @param meta the database meta data
+     * @throws SQLException on failure
      */
     void readParameters(DatabaseMetaData meta) throws SQLException {
         ResultSet rs = meta.getProcedureColumns(null, schema.name, name, null);
diff --git a/h2/src/main/org/h2/command/Token.java b/h2/src/main/org/h2/command/Token.java
@@ -43,27 +43,27 @@ public abstract class Token implements Cloneable {
     static final int EQUAL = LITERAL + 1;
 
     /**
-     * The token ">=".
+     * The token "&gt;=".
      */
     static final int BIGGER_EQUAL = EQUAL + 1;
 
     /**
-     * The token ">".
+     * The token "&gt;".
      */
     static final int BIGGER = BIGGER_EQUAL + 1;
 
     /**
-     * The token "<".
+     * The token "&lt;".
      */
     static final int SMALLER = BIGGER + 1;
 
     /**
-     * The token "<=".
+     * The token "&lt;=".
      */
     static final int SMALLER_EQUAL = SMALLER + 1;
 
     /**
-     * The token "<>" or "!=".
+     * The token "&lt;&gt;" or "!=".
      */
     static final int NOT_EQUAL = SMALLER_EQUAL + 1;
 
diff --git a/h2/src/main/org/h2/fulltext/FullTextLucene.java b/h2/src/main/org/h2/fulltext/FullTextLucene.java
@@ -596,6 +596,7 @@ public void close() throws SQLException {
 
         /**
          * Commit all changes to the Lucene index.
+         * @throws SQLException on failure
          */
         void commitIndex() throws SQLException {
             try {
diff --git a/h2/src/main/org/h2/fulltext/FullTextSettings.java b/h2/src/main/org/h2/fulltext/FullTextSettings.java
@@ -123,7 +123,7 @@ public void addWord(String word, Integer id) {
      * @param indexId the index id
      * @return the index info
      */
-    protected IndexInfo getIndexInfo(int indexId) {
+    IndexInfo getIndexInfo(int indexId) {
         return indexes.get(indexId);
     }
 
@@ -132,7 +132,7 @@ protected IndexInfo getIndexInfo(int indexId) {
      *
      * @param index the index
      */
-    protected void addIndexInfo(IndexInfo index) {
+    void addIndexInfo(IndexInfo index) {
         indexes.put(index.id, index);
     }
 
@@ -143,7 +143,7 @@ protected void addIndexInfo(IndexInfo index) {
      * @param word the word to convert and check
      * @return the uppercase version of the word or null
      */
-    protected String convertWord(String word) {
+    String convertWord(String word) {
         word = normalizeWord(word);
         synchronized (ignoreList) {
             if (ignoreList.contains(word)) {
@@ -158,8 +158,9 @@ protected String convertWord(String word) {
      *
      * @param conn the connection
      * @return the settings
+     * @throws SQLException on failure
      */
-    protected static FullTextSettings getInstance(Connection conn)
+    static FullTextSettings getInstance(Connection conn)
             throws SQLException {
         String path = getIndexPath(conn);
         FullTextSettings setting;
@@ -200,8 +201,9 @@ private static String getIndexPath(Connection conn) throws SQLException {
      * @param conn the connection
      * @param sql the statement
      * @return the prepared statement
+     * @throws SQLException on failure
      */
-    protected synchronized PreparedStatement prepare(Connection conn, String sql)
+    synchronized PreparedStatement prepare(Connection conn, String sql)
             throws SQLException {
         SoftValuesHashMap<String, PreparedStatement> c = cache.get(conn);
         if (c == null) {
diff --git a/h2/src/main/org/h2/jdbc/JdbcBatchUpdateException.java b/h2/src/main/org/h2/jdbc/JdbcBatchUpdateException.java
@@ -19,6 +19,8 @@ public final class JdbcBatchUpdateException extends BatchUpdateException {
 
     /**
      * INTERNAL
+     * @param next exception
+     * @param updateCounts affected record counts
      */
     JdbcBatchUpdateException(SQLException next, int[] updateCounts) {
         super(next.getMessage(), next.getSQLState(), next.getErrorCode(), updateCounts);
@@ -27,6 +29,8 @@ public final class JdbcBatchUpdateException extends BatchUpdateException {
 
     /**
      * INTERNAL
+     * @param next exception
+     * @param updateCounts affected record counts
      */
     JdbcBatchUpdateException(SQLException next, long[] updateCounts) {
         super(next.getMessage(), next.getSQLState(), next.getErrorCode(), updateCounts, null);
diff --git a/h2/src/main/org/h2/jdbc/JdbcResultSet.java b/h2/src/main/org/h2/jdbc/JdbcResultSet.java
@@ -196,6 +196,7 @@ public void close() throws SQLException {
 
     /**
      * Close the result set. This method also closes the statement if required.
+     * @param fromStatement if true - close statement in the end
      */
     void closeInternal(boolean fromStatement) {
         if (result != null) {
diff --git a/h2/src/main/org/h2/jdbcx/JdbcXid.java b/h2/src/main/org/h2/jdbcx/JdbcXid.java
@@ -43,6 +43,9 @@ public final class JdbcXid extends TraceObject implements Xid {
 
     /**
      * INTERNAL
+     * @param builder to put result into
+     * @param xid to provide string representation for
+     * @return provided StringBuilder
      */
     static StringBuilder toString(StringBuilder builder, Xid xid) {
         return builder.append(PREFIX).append('|').append(xid.getFormatId()) //
diff --git a/h2/src/main/org/h2/mvstore/Cursor.java b/h2/src/main/org/h2/mvstore/Cursor.java
@@ -153,14 +153,17 @@ public void skip(long n) {
 
     /**
      * Fetch the next entry that is equal or larger than the given key, starting
-     * from the given page. This method retains the stack.
+     * from the given page. This method returns the path.
      *
      * @param <K> key type
      * @param <V> value type
      *
      * @param page to start from as a root
      * @param key to search for, null means search for the first available key
      * @param reverse true if traversal is in reverse direction, false otherwise
+     * @return CursorPos representing path from the entry found,
+     *         or from insertion point if not,
+     *         all the way up to to the root page provided
      */
     static <K,V> CursorPos<K,V> traverseDown(Page<K,V> page, K key, boolean reverse) {
         CursorPos<K,V> cursorPos = key != null ? CursorPos.traverseDown(page, key) :
diff --git a/h2/src/main/org/h2/server/web/WebServer.java b/h2/src/main/org/h2/server/web/WebServer.java
@@ -796,6 +796,7 @@ synchronized void saveProperties(Properties prop) {
      * @param userKey the key of privileged user
      * @param networkConnectionInfo the network connection information
      * @return the database connection
+     * @throws SQLException on failure
      */
     Connection getConnection(String driver, String databaseUrl, String user,
             String password, String userKey, NetworkConnectionInfo networkConnectionInfo) throws SQLException {
diff --git a/h2/src/main/org/h2/server/web/WebThread.java b/h2/src/main/org/h2/server/web/WebThread.java
@@ -62,7 +62,7 @@ void start() {
      * Wait until the thread is stopped.
      *
      * @param millis the maximum number of milliseconds to wait
-     * @throws InterruptedIOException if interrupted
+     * @throws InterruptedException if interrupted
      */
     void join(int millis) throws InterruptedException {
         thread.join(millis);
diff --git a/h2/src/main/org/h2/store/fs/mem/package.html b/h2/src/main/org/h2/store/fs/mem/package.html
@@ -10,7 +10,6 @@
 </title></head><body style="font: 9pt/130% Tahoma, Arial, Helvetica, sans-serif; font-weight: normal;"><p>
 
 This file system keeps files fully in memory.
-<br/>
 There is an option to compress file blocks to save memory.
 
 </p></body></html>
diff --git a/h2/src/main/org/h2/store/fs/niomapped/package.html b/h2/src/main/org/h2/store/fs/niomapped/package.html
@@ -10,7 +10,6 @@
 </title></head><body style="font: 9pt/130% Tahoma, Arial, Helvetica, sans-serif; font-weight: normal;"><p>
 
 This file system stores files on disk and uses java.nio to access the files.
-<br/>
 This class used memory mapped files.
 
 </p></body></html>
diff --git a/h2/src/main/org/h2/store/fs/niomem/package.html b/h2/src/main/org/h2/store/fs/niomem/package.html
@@ -10,7 +10,6 @@
 </title></head><body style="font: 9pt/130% Tahoma, Arial, Helvetica, sans-serif; font-weight: normal;"><p>
 
 This file system keeps files fully in off-java-heap memory.
-<br/>
 There is an option to compress file blocks to save memory.
 
 </p></body></html>
diff --git a/h2/src/main/org/h2/store/fs/retry/package.html b/h2/src/main/org/h2/store/fs/retry/package.html
@@ -10,8 +10,7 @@
 </title></head><body style="font: 9pt/130% Tahoma, Arial, Helvetica, sans-serif; font-weight: normal;"><p>
 
 A file system that re-opens and re-tries the operation if the file was closed, because a thread was interrupted.
-<br/>
-This will clear the interrupt flag.<br/>
+This will clear the interrupt flag.
 It is mainly useful for applications that call Thread.interrupt by mistake.
 
 </p></body></html>

Original file line number	Diff line number	Diff line change
`@@ -71,6 +71,7 @@ public boolean isReturnsResult() {`
`71`	`71`	`* Read the column for this table from the database meta data.`
`72`	`72`	`*`
`73`	`73`	`* @param meta the database meta data`
	`74`	`+ * @throws SQLException on failure`
`74`	`75`	`*/`
`75`	`76`	`void readParameters(DatabaseMetaData meta) throws SQLException {`
`76`	`77`	`ResultSet rs = meta.getProcedureColumns(null, schema.name, name, null);`
Original file line number	Diff line number	Diff line change
`@@ -62,7 +62,7 @@ void start() {`
`62`	`62`	`* Wait until the thread is stopped.`
`63`	`63`	`*`
`64`	`64`	`* @param millis the maximum number of milliseconds to wait`
`65`		`- * @throws InterruptedIOException if interrupted`
	`65`	`+ * @throws InterruptedException if interrupted`
`66`	`66`	`*/`
`67`	`67`	`void join(int millis) throws InterruptedException {`
`68`	`68`	`thread.join(millis);`