java - 我正在使用 maven-javadoc-plugin，如何将其他模块的文档包含在一起？

Question

我有两个模块，A和B，A依赖于B。它们是完全独立的，B是在内部存储库中部署和使用的。

您想要使用 maven-javadoc-plugin 来记录 A 中的文档，但您还希望包含 B 的依赖模块的内容。例如，您可能有这样的东西

RespostDTO testMethod(int a) { // blabla } 

假设我们在A的模块中有上述方法，RespostDTO就是B的模块代码。在本例中，我们希望在 A 中创建的文档中看到与 RespostDTO 对应的 JavaDoc，该怎么做呢？

A和B模块我应该做什么？

Answer 1

您可以显式地将依赖项添加到 javadoc 生成中:

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-javadoc-plugin</artifactId>
    <configuration>
        <sourcepath>${basedir}/src/main/java</sourcepath>
        <includeDependencySources>true</includeDependencySources>
        <dependencySourceIncludes>
            <dependencySourceInclude>some.group.id1:*</dependencySourceInclude>
            <dependencySourceInclude>some.group.id2:artifactId2</dependencySourceInclude>
        </dependencySourceIncludes>
    </configuration>
</plugin>

来源: https://maven.apache.org/plugins/maven-javadoc-plugin/examples/aggregate-dependency-sources.html#fine-tuning-included-dependencies