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

Javadoc isn't delomboked

Offen
#234 1 Kommentar 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
Vorherrschende Sprache
Java
Sterne
30
Forks
48
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

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.

Beitragsleitfaden

Beitragsleitfaden öffnen

Bewertung

Dieses Issue wurde noch nicht bewertet.

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.