Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Javadoc isn't delomboked #234

Open
otterley opened this issue Feb 17, 2020 · 1 comment
Open

Javadoc isn't delomboked #234

otterley opened this issue Feb 17, 2020 · 1 comment

Comments

@otterley
Copy link

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.

@rjlohan
Copy link
Contributor

rjlohan commented Feb 21, 2020

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants