[opt]: fix java doc warning

lindb · Apr 6, 2023 · 96c296e · 96c296e
1 parent 8d67a41
commit 96c296e
Show file tree

Hide file tree

Showing 6 changed files with 17 additions and 4 deletions.
diff --git a/src/main/java/io/lindb/client/api/BaseQuery.java b/src/main/java/io/lindb/client/api/BaseQuery.java
@@ -30,6 +30,9 @@ public abstract class BaseQuery {
 
 	/**
 	 * Create base query instance.
+	 * 
+	 * @param url    url
+	 * @param client http client
 	 */
 	protected BaseQuery(String url, HttpClient client) {
 		this.url = url;

diff --git a/src/main/java/io/lindb/client/api/DataQuery.java b/src/main/java/io/lindb/client/api/DataQuery.java
@@ -38,6 +38,8 @@ public interface DataQuery {
 	 * @return result set
 	 * @throws Exception throws exception when query failure
 	 */
+	/**
+	 */
 	ResultSet dataQuery(String database, String ql) throws Exception;
 
 	/**
@@ -46,6 +48,7 @@ public interface DataQuery {
 	 * Example:
 	 * show fields from lindb.runtime.mem
 	 * 
+	 * @param <T>      result type
 	 * @param database database name
 	 * @param ql       lin query language
 	 * @return result set

diff --git a/src/main/java/io/lindb/client/api/DataQueryImpl.java b/src/main/java/io/lindb/client/api/DataQueryImpl.java
@@ -29,6 +29,9 @@ public class DataQueryImpl extends BaseQuery implements DataQuery {
 
 	/**
 	 * Create data query instance.
+	 * 
+	 * @param url    url
+	 * @param client http client
 	 */
 	public DataQueryImpl(String url, HttpClient client) {
 		super(url, client);

diff --git a/src/main/java/io/lindb/client/api/MetadataManagerImpl.java b/src/main/java/io/lindb/client/api/MetadataManagerImpl.java
@@ -34,8 +34,8 @@ public class MetadataManagerImpl implements MetadataManager {
 	/**
 	 * Create metadata manager instance.
 	 * 
-	 * @param url
-	 * @param client
+	 * @param url    url
+	 * @param client http client
 	 */
 	public MetadataManagerImpl(String url, HttpClient client) {
 		this.url = url;

diff --git a/src/main/java/io/lindb/client/api/StateQueryImpl.java b/src/main/java/io/lindb/client/api/StateQueryImpl.java
@@ -40,6 +40,9 @@ public class StateQueryImpl extends BaseQuery implements StateQuery {
 
 	/**
 	 * Create state query instance.
+	 * 
+	 * @param url    url
+	 * @param client http client
 	 */
 	public StateQueryImpl(String url, HttpClient client) {
 		super(url, client);

diff --git a/src/main/java/io/lindb/client/util/JsonUtil.java b/src/main/java/io/lindb/client/util/JsonUtil.java
@@ -53,8 +53,9 @@ public static String toString(Object object) throws Exception {
 	/**
 	 * Json string to object
 	 * 
-	 * @param json json string
-	 * @param <T>  Object type
+	 * @param json  json string
+	 * @param <T>   Object type
+	 * @param clazz result class
 	 * @return T object
 	 * @throws Exception throws exception when fail
 	 */