From 67ff035263bbf8c0bf486f9980b7aeb21117874c Mon Sep 17 00:00:00 2001 From: Zhichun Wu Date: Sat, 16 Apr 2022 17:37:16 +0800 Subject: [PATCH] Fix javadoc error on CI --- .../com/clickhouse/client/ClickHouseByteBuffer.java | 2 ++ .../java/com/clickhouse/client/ClickHouseDataType.java | 1 + .../com/clickhouse/client/ClickHouseException.java | 2 ++ .../com/clickhouse/client/ClickHouseInputStream.java | 2 +- .../clickhouse/client/ClickHouseResponseSummary.java | 10 +++++----- .../client/data/ClickHouseSimpleResponse.java | 1 + .../client/stream/AbstractByteBufferInputStream.java | 1 + 7 files changed, 13 insertions(+), 6 deletions(-) diff --git a/clickhouse-client/src/main/java/com/clickhouse/client/ClickHouseByteBuffer.java b/clickhouse-client/src/main/java/com/clickhouse/client/ClickHouseByteBuffer.java index 3adb6d006..dab766d5f 100644 --- a/clickhouse-client/src/main/java/com/clickhouse/client/ClickHouseByteBuffer.java +++ b/clickhouse-client/src/main/java/com/clickhouse/client/ClickHouseByteBuffer.java @@ -278,6 +278,8 @@ public ClickHouseByteBuffer reverse() { /** * Reverses the byte array. * + * @param offset start position + * @param length bytes to reserve * @return this byte buffer */ public ClickHouseByteBuffer reverse(int offset, int length) { diff --git a/clickhouse-client/src/main/java/com/clickhouse/client/ClickHouseDataType.java b/clickhouse-client/src/main/java/com/clickhouse/client/ClickHouseDataType.java index 5cfd1ffe7..bf17c0713 100644 --- a/clickhouse-client/src/main/java/com/clickhouse/client/ClickHouseDataType.java +++ b/clickhouse-client/src/main/java/com/clickhouse/client/ClickHouseDataType.java @@ -183,6 +183,7 @@ public static List match(String part) { /** * Checks if any alias uses the given prefix. * + * @param prefix prefix to check * @return true if any alias using the given prefix; false otherwise */ public static boolean mayStartWith(String prefix) { diff --git a/clickhouse-client/src/main/java/com/clickhouse/client/ClickHouseException.java b/clickhouse-client/src/main/java/com/clickhouse/client/ClickHouseException.java index ff5560bec..fb0a3ddf8 100644 --- a/clickhouse-client/src/main/java/com/clickhouse/client/ClickHouseException.java +++ b/clickhouse-client/src/main/java/com/clickhouse/client/ClickHouseException.java @@ -155,6 +155,8 @@ public ClickHouseException(int code, String message, ClickHouseNode server) { /** * Gets error code. + * + * @return error code */ public int getErrorCode() { return errorCode; diff --git a/clickhouse-client/src/main/java/com/clickhouse/client/ClickHouseInputStream.java b/clickhouse-client/src/main/java/com/clickhouse/client/ClickHouseInputStream.java index f66c58f3d..34b3aa21b 100644 --- a/clickhouse-client/src/main/java/com/clickhouse/client/ClickHouseInputStream.java +++ b/clickhouse-client/src/main/java/com/clickhouse/client/ClickHouseInputStream.java @@ -29,7 +29,7 @@ /** * Extended input stream for read optimization. Methods like * {@link #readBuffer(int)}, {@link #readByte()}, {@link #readBytes(int)}, and - * {@link #readCustom(ClickHouseDataReader)} are added to reduce object + * {@link #readCustom(ClickHouseDataUpdater)} are added to reduce object * creation as well as closing the stream when it reaches end of stream. This * class is also responsible for creating various input stream as needed. */ diff --git a/clickhouse-client/src/main/java/com/clickhouse/client/ClickHouseResponseSummary.java b/clickhouse-client/src/main/java/com/clickhouse/client/ClickHouseResponseSummary.java index c13581c2a..c75c9b8aa 100644 --- a/clickhouse-client/src/main/java/com/clickhouse/client/ClickHouseResponseSummary.java +++ b/clickhouse-client/src/main/java/com/clickhouse/client/ClickHouseResponseSummary.java @@ -78,11 +78,11 @@ public static class Statistics implements Serializable { /** * Default constructor. * - * @param rows The total number of output rows - * @param blocks - * @param allocated_bytes - * @param applied_limit - * @param rows_before_limit The minimal number of rows there would have been + * @param rows total number of output rows + * @param blocks total number of blocks + * @param allocated_bytes allocated bytes + * @param applied_limit whether limit was applied or not + * @param rows_before_limit minimal number of rows there would have been * without LIMIT */ public Statistics(long rows, long blocks, long allocated_bytes, boolean applied_limit, long rows_before_limit) { diff --git a/clickhouse-client/src/main/java/com/clickhouse/client/data/ClickHouseSimpleResponse.java b/clickhouse-client/src/main/java/com/clickhouse/client/data/ClickHouseSimpleResponse.java index a3a34c960..981726cf0 100644 --- a/clickhouse-client/src/main/java/com/clickhouse/client/data/ClickHouseSimpleResponse.java +++ b/clickhouse-client/src/main/java/com/clickhouse/client/data/ClickHouseSimpleResponse.java @@ -46,6 +46,7 @@ public static ClickHouseResponse of(ClickHouseConfig config, List columns, Object[][] values, diff --git a/clickhouse-client/src/main/java/com/clickhouse/client/stream/AbstractByteBufferInputStream.java b/clickhouse-client/src/main/java/com/clickhouse/client/stream/AbstractByteBufferInputStream.java index 30f1ca577..3750eb50e 100644 --- a/clickhouse-client/src/main/java/com/clickhouse/client/stream/AbstractByteBufferInputStream.java +++ b/clickhouse-client/src/main/java/com/clickhouse/client/stream/AbstractByteBufferInputStream.java @@ -37,6 +37,7 @@ protected void ensureOpen() throws IOException { * Update inner buffer as needed. * * @return remaining bytes in buffer + * @throws IOException when failed to update buffer */ protected abstract int updateBuffer() throws IOException;