cloudformation-cli-java-plugin icon indicating copy to clipboard operation
cloudformation-cli-java-plugin copied to clipboard

Javadoc isn't delomboked

Open otterley opened this issue 5 years ago • 1 comments

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 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:
    <plugin>
      <groupId>org.projectlombok</groupId>
      <artifactId>lombok-maven-plugin</artifactId>
      <version>1.18.10.0</version>
      <executions>
        <execution>
          <phase>generate-sources</phase>
          <goals>
            <goal>delombok</goal>
          </goals>
        </execution>
      </executions>
    </plugin>

After that, the javadoc goal produces the full documentation.

otterley avatar Feb 17 '20 16:02 otterley

We'd happily take a PR to improve this. 👍

rjlohan avatar Feb 21 '20 20:02 rjlohan