aws-cloudformation / aws-cloudformation/cloudformation-cli-java-plugin

Javadoc isn't delomboked

Aperta
#234 1 commento 0 reazioni 0 assegnatari Vedi su GitHub
Lingua principale
Java
Stelle
30
Fork
48
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

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.

Guida per i contributori

Apri la guida per i contributori

Valutazione

Questa issue non è ancora stata valutata.

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.