Maven:依赖驱动的javadoc聚合和自定义doclet

Question

我准备了一个非常简单的演示，说明我想以更大的规模来演示这个问题：

配置： java 1.8， maven 3.3.9， maven-javadoc-plugin 3.0.1

我有 maven 工件 testA、testB 和 testC。组件测试A是一个javadoc聚合器项目。类 B(位于 testB 组件中(导入并实例化类 C(位于 testC 组件中(。

testA 对 testB 有直接依赖关系，testB 对 testC 有直接依赖关系(两者都提供了范围(，因此 testA 对 testC 有传递依赖性。

此外，类 B 使用自定义 javadoc 标记进行标记。

由于我没有编写文档的经验，所以我使用了在互联网上找到的doclet并根据自己的需要进行修改(基本上我只是重写了排除方法以仅包含包含自定义标签的类文档(。

如上所述，testA 是一个聚合器，旨在仅从直接(非传递(依赖项中收集依赖项源，并仅为标记类生成 javadoc。这需要任何直接依赖项在构建过程中捆绑其源代码，因此我使用 maven-source-plugin 从组件 testB 生成源工件。

现在，问题是，当我运行 maven javadoc 插件时，它在此异常上失败：

[ERROR] java.lang.ArrayIndexOutOfBoundsException: 0
[ERROR] at com.sun.tools.doclets.formats.html.ConfigurationImpl.setTopFile(ConfigurationImpl.java:537)

异常是指此行：

this.topFile = DocPath.forPackage(this.packages[0]).resolve(DocPaths.PACKAGE_SUMMARY); 

似乎没有要处理的包。但是，我确信文档在单个组件上执行时按预期工作(非聚合用法，在没有 maven - javadoc cmd 的情况下尝试(。当我使用标准文档时，整个聚合功能也有效，但这对我来说没有用，因为我真的只需要包含标记的类。

这是我的聚合器的POM.xml：

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>test</groupId>
<artifactId>testA</artifactId>
<version>1</version>
<dependencies>
<dependency>
<groupId>com.sun</groupId>
<artifactId>tools</artifactId>
<version>1.8</version>
<scope>system</scope>
<systemPath>${java.home}/../lib/tools.jar</systemPath>
</dependency>
<dependency>
<groupId>test</groupId>
<artifactId>testB</artifactId>
<version>1</version>
<scope>provided</scope>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>3.0.1</version>
<configuration>
<destDir>testOutput</destDir>
<includeDependencySources>true</includeDependencySources>
<doclet>com.test.MyDoclet</doclet>
<docletArtifact>
<groupId>test</groupId>
<artifactId>my-doclet-artifact</artifactId>
<version>1</version>
</docletArtifact>
<useStandardDocletOptions>true</useStandardDocletOptions>
<tags>
<tag>
<name>MyTag</name>
</tag>
</tags>
</configuration>
</plugin>
</plugins>
</build>
</project>

我做错了什么？有人可以帮我吗？

Answer 1

实际上，我设法让它工作。问题出在文档代码上。我不知道javadoc如何处理代码元素。

有一个从 RootDoc 节点开始的树结构。从那里它把这棵树走下来。RootDoc -> 包 ->类 -> 成员等。 由于我只处理了标记的类，因此跳过了其他所有内容。因此，递归在一开始就被破坏了 - 没有一个 PackageDoc 元素通过条件，所以最终没有处理任何内容。

我可以为 javadoc 存储(包含(任何我想要的东西，但我必须确保无论处理什么类型的元素，递归都会继续。