Skip to content

Commit 36e790d

Browse files
andreitokarandreitokar
committed
make javadoc happier
1 parent 1c0ca27 commit 36e790d

14 files changed

Lines changed: 29 additions & 17 deletions

File tree

‎h2/src/main/org/h2/bnf/context/DbProcedure.java‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,7 @@ public boolean isReturnsResult() {
7171
* Read the column for this table from the database meta data.
7272
*
7373
* @param meta the database meta data
74+
* @throws SQLException on failure
7475
*/
7576
void readParameters(DatabaseMetaData meta) throws SQLException {
7677
ResultSet rs = meta.getProcedureColumns(null, schema.name, name, null);

‎h2/src/main/org/h2/command/Token.java‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -43,27 +43,27 @@ public abstract class Token implements Cloneable {
4343
static final int EQUAL = LITERAL + 1;
4444

4545
/**
46-
* The token ">=".
46+
* The token ">=".
4747
*/
4848
static final int BIGGER_EQUAL = EQUAL + 1;
4949

5050
/**
51-
* The token ">".
51+
* The token ">".
5252
*/
5353
static final int BIGGER = BIGGER_EQUAL + 1;
5454

5555
/**
56-
* The token "<".
56+
* The token "&lt;".
5757
*/
5858
static final int SMALLER = BIGGER + 1;
5959

6060
/**
61-
* The token "<=".
61+
* The token "&lt;=".
6262
*/
6363
static final int SMALLER_EQUAL = SMALLER + 1;
6464

6565
/**
66-
* The token "<>" or "!=".
66+
* The token "&lt;&gt;" or "!=".
6767
*/
6868
static final int NOT_EQUAL = SMALLER_EQUAL + 1;
6969

‎h2/src/main/org/h2/fulltext/FullTextLucene.java‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -596,6 +596,7 @@ public void close() throws SQLException {
596596

597597
/**
598598
* Commit all changes to the Lucene index.
599+
* @throws SQLException on failure
599600
*/
600601
void commitIndex() throws SQLException {
601602
try {

‎h2/src/main/org/h2/fulltext/FullTextSettings.java‎

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ public void addWord(String word, Integer id) {
123123
* @param indexId the index id
124124
* @return the index info
125125
*/
126-
protected IndexInfo getIndexInfo(int indexId) {
126+
IndexInfo getIndexInfo(int indexId) {
127127
return indexes.get(indexId);
128128
}
129129

@@ -132,7 +132,7 @@ protected IndexInfo getIndexInfo(int indexId) {
132132
*
133133
* @param index the index
134134
*/
135-
protected void addIndexInfo(IndexInfo index) {
135+
void addIndexInfo(IndexInfo index) {
136136
indexes.put(index.id, index);
137137
}
138138

@@ -143,7 +143,7 @@ protected void addIndexInfo(IndexInfo index) {
143143
* @param word the word to convert and check
144144
* @return the uppercase version of the word or null
145145
*/
146-
protected String convertWord(String word) {
146+
String convertWord(String word) {
147147
word = normalizeWord(word);
148148
synchronized (ignoreList) {
149149
if (ignoreList.contains(word)) {
@@ -158,8 +158,9 @@ protected String convertWord(String word) {
158158
*
159159
* @param conn the connection
160160
* @return the settings
161+
* @throws SQLException on failure
161162
*/
162-
protected static FullTextSettings getInstance(Connection conn)
163+
static FullTextSettings getInstance(Connection conn)
163164
throws SQLException {
164165
String path = getIndexPath(conn);
165166
FullTextSettings setting;
@@ -200,8 +201,9 @@ private static String getIndexPath(Connection conn) throws SQLException {
200201
* @param conn the connection
201202
* @param sql the statement
202203
* @return the prepared statement
204+
* @throws SQLException on failure
203205
*/
204-
protected synchronized PreparedStatement prepare(Connection conn, String sql)
206+
synchronized PreparedStatement prepare(Connection conn, String sql)
205207
throws SQLException {
206208
SoftValuesHashMap<String, PreparedStatement> c = cache.get(conn);
207209
if (c == null) {

‎h2/src/main/org/h2/jdbc/JdbcBatchUpdateException.java‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@ public final class JdbcBatchUpdateException extends BatchUpdateException {
1919

2020
/**
2121
* INTERNAL
22+
* @param next exception
23+
* @param updateCounts affected record counts
2224
*/
2325
JdbcBatchUpdateException(SQLException next, int[] updateCounts) {
2426
super(next.getMessage(), next.getSQLState(), next.getErrorCode(), updateCounts);
@@ -27,6 +29,8 @@ public final class JdbcBatchUpdateException extends BatchUpdateException {
2729

2830
/**
2931
* INTERNAL
32+
* @param next exception
33+
* @param updateCounts affected record counts
3034
*/
3135
JdbcBatchUpdateException(SQLException next, long[] updateCounts) {
3236
super(next.getMessage(), next.getSQLState(), next.getErrorCode(), updateCounts, null);

‎h2/src/main/org/h2/jdbc/JdbcResultSet.java‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -196,6 +196,7 @@ public void close() throws SQLException {
196196

197197
/**
198198
* Close the result set. This method also closes the statement if required.
199+
* @param fromStatement if true - close statement in the end
199200
*/
200201
void closeInternal(boolean fromStatement) {
201202
if (result != null) {

‎h2/src/main/org/h2/jdbcx/JdbcXid.java‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,9 @@ public final class JdbcXid extends TraceObject implements Xid {
4343

4444
/**
4545
* INTERNAL
46+
* @param builder to put result into
47+
* @param xid to provide string representation for
48+
* @return provided StringBuilder
4649
*/
4750
static StringBuilder toString(StringBuilder builder, Xid xid) {
4851
return builder.append(PREFIX).append('|').append(xid.getFormatId()) //

‎h2/src/main/org/h2/mvstore/Cursor.java‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -153,14 +153,17 @@ public void skip(long n) {
153153

154154
/**
155155
* Fetch the next entry that is equal or larger than the given key, starting
156-
* from the given page. This method retains the stack.
156+
* from the given page. This method returns the path.
157157
*
158158
* @param <K> key type
159159
* @param <V> value type
160160
*
161161
* @param page to start from as a root
162162
* @param key to search for, null means search for the first available key
163163
* @param reverse true if traversal is in reverse direction, false otherwise
164+
* @return CursorPos representing path from the entry found,
165+
* or from insertion point if not,
166+
* all the way up to to the root page provided
164167
*/
165168
static <K,V> CursorPos<K,V> traverseDown(Page<K,V> page, K key, boolean reverse) {
166169
CursorPos<K,V> cursorPos = key != null ? CursorPos.traverseDown(page, key) :

‎h2/src/main/org/h2/server/web/WebServer.java‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -796,6 +796,7 @@ synchronized void saveProperties(Properties prop) {
796796
* @param userKey the key of privileged user
797797
* @param networkConnectionInfo the network connection information
798798
* @return the database connection
799+
* @throws SQLException on failure
799800
*/
800801
Connection getConnection(String driver, String databaseUrl, String user,
801802
String password, String userKey, NetworkConnectionInfo networkConnectionInfo) throws SQLException {

‎h2/src/main/org/h2/server/web/WebThread.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ void start() {
6262
* Wait until the thread is stopped.
6363
*
6464
* @param millis the maximum number of milliseconds to wait
65-
* @throws InterruptedIOException if interrupted
65+
* @throws InterruptedException if interrupted
6666
*/
6767
void join(int millis) throws InterruptedException {
6868
thread.join(millis);

0 commit comments

Comments
 (0)