Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Resolve the JavaDoc warning of openmldb-jdbc #1319

Closed
tobegit3hub opened this issue Feb 25, 2022 · 3 comments · Fixed by #1863
Closed

Resolve the JavaDoc warning of openmldb-jdbc #1319

tobegit3hub opened this issue Feb 25, 2022 · 3 comments · Fixed by #1863
Assignees
Labels
enhancement New feature or request good first issue Good for newcomers

Comments

@tobegit3hub
Copy link
Collaborator

tobegit3hub commented Feb 25, 2022

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
Copy link
Contributor

Ivyee17 commented May 20, 2022

WeOpen Star. Hope to fix this problem, and please assign it to me. thx

@lumianph
Copy link
Collaborator

WeOpen Star. Hope to fix this problem, and please assign it to me. thx

I have assigned to you, looking forward to your PR

@Ivyee17
Copy link
Contributor

Ivyee17 commented May 21, 2022

I've issued a pr for this problem #1863. thx.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants