4paradigm / 4paradigm/OpenMLDB
Resolve the JavaDoc warning of hybridse-proto and openmldb-native
- Vorherrschende Sprache
- C++
- Sterne
- 1.7k
- Forks
- 331
- Ø Merge
- 12 T. 12 Std.
- Gemergte PRs (30 T.)
- 1
Beschreibung
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.
Beitragsleitfaden
Rechercherichtung
The warnings are from the maven-javadoc-plugin when building the hybridse-proto module. Look at the generated Java code in java/hybridse-proto/src/main/java/com/_4paradigm/hybridse/tablet/Tablet.java. Investigate the protobuf configuration or maven plugin settings to suppress javadoc warnings for generated code. Run `mvn clean package` to reproduce, then check the pom.xml for javadoc plugin configuration.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- java
- Bereich
- build-system, documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 2/5
- Geschätzter Aufwand
- 1-3 Stunden
- Aktivitätsstatus
- Veraltet
- Klarheit
- Klar beschrieben
- Anfängerfreundlichkeit
- 65/100