4paradigm / 4paradigm/OpenMLDB

Resolve the JavaDoc warning of hybridse-proto and openmldb-native

未关闭
#1,318 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看
enhancement
主要语言
C++
星标
1.7k
派生
331
平均合并
12 天 12 小时
30 天内合并 PR
1

描述

Now we can get logs of warning of Java module `hybridse-proto` when compiling.

```
[INFO] --- maven-javadoc-plugin:2.9.1:jar (attach-javadocs) @ hybridse-proto ---
[INFO]
100 warnings
[WARNING] Javadoc Warnings
[WARNING] /Users/tobe/code/4pd/OpenMLDB/java/hybridse-proto/src/main/java/com/_4paradigm/hybridse/tablet/Tablet.java:2495: warning: no @return
[WARNING] boolean hasTable(); [WARNING] ^
[WARNING] /Users/tobe/code/4pd/OpenMLDB/java/hybridse-proto/src/main/java/com/_4paradigm/hybridse/tablet/Tablet.java:2499: warning: no @return
[WARNING] com._4paradigm.hybridse.type.TypeOuterClass.TableDef getTable();
[WARNING] ^
[WARNING] /Users/tobe/code/4pd/OpenMLDB/java/hybridse-proto/src/main/java/com/_4paradigm/hybridse/tablet/Tablet.java:2503: warning: no @return
[WARNING] com._4paradigm.hybridse.type.TypeOuterClass.TableDefOrBuilder getTableOrBuilder();
[WARNING] ^
[WARNING] /Users/tobe/code/4pd/OpenMLDB/java/hybridse-proto/src/main/java/com/_4paradigm/hybridse/tablet/Tablet.java:2508: warning: no @return
[WARNING] boolean hasTid();
[WARNING] ^
[WARNING] /Users/tobe/code/4pd/OpenMLDB/java/hybridse-proto/src/main/java/com/_4paradigm/hybridse/tablet/Tablet.java:2512: warning: no @return
[WARNING] int getTid();
[WARNING] ^
[WARNING] /Users/tobe/code/4pd/OpenMLDB/java/hybridse-proto/src/main/java/com/_4paradigm/hybridse/tablet/Tablet.java:2517: warning: no @return
[WARNING] java.util.List getPidsList();
[WARNING] ^
[WARNING] /Users/tobe/code/4pd/OpenMLDB/java/hybridse-proto/src/main/java/com/_4paradigm/hybridse/tablet/Tablet.java:2521: warning: no @return
[WARNING] int getPidsCount();
[WARNING] ^
[WARNING] /Users/tobe/code/4pd/OpenMLDB/java/hybridse-proto/src/main/java/com/_4paradigm/hybridse/tablet/Tablet.java:2525: warning: no @param for in
dex
[WARNING] int getPids(int index);
[WARNING] ^
[WARNING] /Users/tobe/code/4pd/OpenMLDB/java/hybridse-proto/src/main/java/com/_4paradigm/hybridse/tablet/Tablet.java:2525: warning: no @return

......
```

You can reproduce the issue by compiling java modules with `mvn clean package`.

Since the code is generated by `protobuf` and it would be better to find a way to dismiss the warning.

贡献指南

打开贡献指南

评估

这个 Issue 还没有评估数据。

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。