Resolve the JavaDoc warning of openmldb-jdbc
Closed this issue · 3 comments
tobegit3hub commented
Now we can get logs of warning of Java module openmldb-jdbc when compiling.
10 warnings
[WARNING] Javadoc Warnings
[WARNING] /Users/tobe/code/4pd/OpenMLDB/java/openmldb-jdbc/src/main/java/com/_4paradigm/openmldb/jdbc/SQLResultSet.java:333: warning: no description
for @param
[WARNING] * @param s
[WARNING] ^
[WARNING] /Users/tobe/code/4pd/OpenMLDB/java/openmldb-jdbc/src/main/java/com/_4paradigm/openmldb/common/LibraryLoader.java:93: warning: no @param fo
r path
[WARNING] public static String extractResource(String path, boolean isTemp) throws IOException {
[WARNING] ^
[WARNING] /Users/tobe/code/4pd/OpenMLDB/java/openmldb-jdbc/src/main/java/com/_4paradigm/openmldb/common/LibraryLoader.java:93: warning: no @param fo
r isTemp
[WARNING] public static String extractResource(String path, boolean isTemp) throws IOException {
[WARNING] ^
[WARNING] /Users/tobe/code/4pd/OpenMLDB/java/openmldb-jdbc/src/main/java/com/_4paradigm/openmldb/common/LibraryLoader.java:93: warning: no @return
[WARNING] public static String extractResource(String path, boolean isTemp) throws IOException {
[WARNING] ^
[WARNING] /Users/tobe/code/4pd/OpenMLDB/java/openmldb-jdbc/src/main/java/com/_4paradigm/openmldb/common/LibraryLoader.java:93: warning: no @throws f
or java.io.IOException
[WARNING] public static String extractResource(String path, boolean isTemp) throws IOException {
[WARNING] ^
[WARNING] /Users/tobe/code/4pd/OpenMLDB/java/openmldb-jdbc/src/main/java/com/_4paradigm/openmldb/sdk/QueryFuture.java:73: warning: no description fo
r @param
[WARNING] * @param timeUnit
[WARNING] ^
[WARNING] /Users/tobe/code/4pd/OpenMLDB/java/openmldb-jdbc/src/main/java/com/_4paradigm/openmldb/sdk/QueryFuture.java:74: warning: no description fo
r @return
[WARNING] * @return
[WARNING] ^
[WARNING] /Users/tobe/code/4pd/OpenMLDB/java/openmldb-jdbc/src/main/java/com/_4paradigm/openmldb/sdk/QueryFuture.java:75: warning: no description fo
r @throws
[WARNING] * @throws InterruptedException
[WARNING] ^
[WARNING] /Users/tobe/code/4pd/OpenMLDB/java/openmldb-jdbc/src/main/java/com/_4paradigm/openmldb/sdk/QueryFuture.java:76: warning: no description fo
r @throws
[WARNING] * @throws ExecutionException
[WARNING] ^
[WARNING] /Users/tobe/code/4pd/OpenMLDB/java/openmldb-jdbc/src/main/java/com/_4paradigm/openmldb/sdk/QueryFuture.java:77: warning: no description fo
r @throws
......
You can reproduce the issue by compiling java modules with mvn clean package.
Ivyee17 commented
WeOpen Star. Hope to fix this problem, and please assign it to me. thx
lumianph commented
WeOpen Star. Hope to fix this problem, and please assign it to me. thx
I have assigned to you, looking forward to your PR