4paradigm / 4paradigm/OpenMLDB

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

Đang mở Phù hợp với người mới
#1,318 0 bình luận 0 reaction 0 người được giao Xem trên GitHub
enhancement
Ngôn ngữ chính
C++
Star
1.7k
Fork
331
Merge trung bình
12 ngày 12 giờ
Pull request đã merge (30 ngày)
1

Mô tả

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.

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Hướng nghiên cứu

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.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Đánh giá

Công nghệ
java
Lĩnh vực
build-system, documentation
Loại issue
Tài liệu
Độ khó
2/5
Thời gian dự kiến
1-3 giờ
Mức độ hoạt động
Đình trệ
Độ rõ ràng
Đặc tả rõ ràng
Mức phù hợp với người mới
65/100

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.