Lombok Maven javadoc：带有生成源的聚合报告

Question

我有一个使用Maven构建的多模块java项目，我想使用javadoc：聚合生成javadocs。项目结构如下所示：

parent
├─lomboklib
└─other

我也在使用Project Lombok在项目中生成一些方法。我已经通过首先使用Lombok maven插件运行delombok成功地将其配置为与单个模块一起使用。对于单个模块（lomboklib），这将在

target/generated-sources/delombok

然后由maven-javadoc-plugin和javadoc工具处理。这最初是在这个SO问题中解决的。

如何配置javadoc:aggregate报告以同时使用生成的源？

我已经为Github中所有模块定义的问题建立了一个沙箱。理想情况下，我应该能够跑步

mvn clean compile javadoc:aggregate

在父项目中，并编译整个东西并为整个项目获取javadocs。

Answer 1

我也遇到了同样的问题，我能够通过直接从父项目引用源路径来解决这个问题。

为您的父pom的maven javadoc插件尝试此配置。

<configuration>
    <sourcepath>
        lomboklib/target/generated-sources/delombok;
        other/target/generated-sources/delombok
    </sourcepath>
</configuration>

这真的不理想。感觉有点像黑客。

Answer 2

我从Github下载了示例项目来重新创建您的问题，并发现这是因为lombok maven插件在顶级pom上配置得不必要——它只需要用于包含lombok代码的模块。通过简单地删除该配置，javadoc:aggregate的行为符合预期。

Answer 3

我创建了一个变通构建配置，该配置将从生成的源创建聚合的Javadoc，尽管调用序列有两个步骤：

mvn package
mvn -N pre-site

构建配置现在发布在Github中。当前版本仅支持深度为1的项目树，但当然可以修改。它通过收集父目录下的依赖项，然后运行包含的Ant脚本来工作。

最后，如果在Jenkins下运行，则可以通过执行shell post步骤在同一作业中调用mvn-N pre-site。在我们的Jenkins版本中发布javadocs需要使用构建后操作“使用其他项目的发布者”。