Aggregator goal for generating sources

Related to SO 29563593.

I am trying to compile aggregated javadocs for a multimodule Maven project. The parent project has a packaging of pom and it seems like Maven will not run any of the standard goals.

I am proposing to add a goal to lombok-maven-plugin annotated with @aggregator, which would

• delombok aggregated sources
• add those to the sourcepath

If everything works out as planned, this could then be processed by the maven-javadoc-plugin.

[awhitford]

The reason why this isn’t working for you is because you are running javadoc against the original source java, not the resulting java from delombok.

The delombok goal is designed to transform java code from src/main/lombok to target/generated-source/delombok. Then, the other java code found in src/main/java is combined with target/generated-source/delombok to produce the elaborated javadoc.

You have to think of delombok as a source code generator.

By forcing the delombok goal to run against src/main/java (and disabling the addOutputDirectory), the original java source is unchanged, and then javadoc runs only against the original java source. Now I understand why you need to disable addOutputDirectory – otherwise you will get a duplicate class compilation error.

So how can you get what you really want? (Note that Maven has an addCompileSourceRoot method, but not a corresponding removeCompileSourceRoot.) Imagine the following hack:

1. Override the default <build><sourceDirectory> from src/main/java to be ${project.build.directory}/generated-sources/delombok.
2. Override the default delombok sourceDirectory from src/main/lombok to be src/main/java, and disable addOutputDirectory (as you have it).

Basically, you will use src/main/java, but Maven will ignore it and instead use target/generated-sources/delombok. The Lombok plugin will transform src/main/java into elaborated code in target/generated-sources/delombok. You had step 2, you were just missing step 1.

Use this hack at your own risk. (My guess is that this may confuse your IDE and some other developers.)

  <build>
    <sourceDirectory>${project.build.directory}/generated-sources/delombok</sourceDirectory>
    <plugins>
      <plugin>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok-maven-plugin</artifactId>
        <version>1.16.6.1</version>
        <executions>
          <execution>
            <id>delombok</id>
            <phase>generate-sources</phase>
            <goals>
              <goal>delombok</goal>
            </goals>
            <configuration>
              <addOutputDirectory>false</addOutputDirectory>
              <sourceDirectory>src/main/java</sourceDirectory>
            </configuration>
          </execution>
        </executions>
      </plugin>
    </plugins>
  </build>

[eaaltonen]

@awhitford What were your results? Were the Lombok generated methods included in the output Javadoc?