aws-cloudformation / aws-cloudformation/cloudformation-cli-java-plugin
Javadoc isn't delomboked
- Dominant language
- Java
- Stars
- 30
- Forks
- 48
- PR merge metrics
- No merged PRs in 30d
Description
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.
Contributor guide
Assessment
This issue has not been assessed yet.