aws-cloudformation / aws-cloudformation/cloudformation-cli-java-plugin
Javadoc isn't delomboked
- 主要語言
- Java
- 星號
- 30
- 分支
- 48
- PR 合併指標
- 30 天內沒有已合併 PR
描述
The documentation generated by `mvn javadoc:javadoc` is missing the methods auto-generated by Lombok. So, the documentation is missing methods like `builder()` that are used in our examples.
There's a [Maven plugin](http://anthonywhitford.com/lombok.maven/lombok-maven-plugin/index.html) that helps. I've tried it and it seems to work. The steps are:
1. Moving the source code from `src/main/java` to `src/main/lombok`
2. Adding the following stanza to `pom.xml`:
```xml
org.projectlombok
lombok-maven-plugin
1.18.10.0
generate-sources
delombok
```
After that, the javadoc goal produces the full documentation.
貢獻指南
研究方向
Review the Java sources under src/main/java and the build configuration in pom.xml, then compare the current Maven Javadoc output with the documented builder() methods. Investigate the proposed lombok-maven-plugin delombok setup and verify that mvn javadoc:javadoc produces documentation containing the generated methods.
由索引模型根據 Issue 內容生成。
評估
- 技術堆疊
- java
- 領域
- build-system, documentation
- Issue 類型
- 缺陷
- 難度
- 3/5
- 預估耗時
- 1-2 天
- 活躍度
- 停滯
- 描述清晰度
- 描述清楚
- 新手友好度
- 35/100