Maven JXR 插件——将 JXR 文件链接到 Javadocs

将 JXR 文件链接到 Javadocs

要将生成的 JXR 文件链接到 Javadocs，您需要在您的中设置以下 JXR 插件配置pom.xml：

<project>
  ...
  <reporting>
    <plugins>
      ...
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-jxr-plugin</artifactId>
        <version>3.2.0</version>
        <configuration>
          ...
          <linkJavadoc>true</linkJavadoc>
          <javadocDir>/path/to/javadocs</javadocDir>
          ...
        </configuration>
      </plugin>
    </plugins>
  ...
  </reporting>
  ...
</project>

生成的 JXR 页面将有一个名为“View Javadoc”的链接，该链接将显示该类的 Javadoc。如果指定的 Javadoc 目录中没有现有的 Javadocs 并且不会生成 Javadocs（意味着 POM 的报告部分中没有 Javadoc 插件配置），即使linkJavadoc参数设置为，也不会显示链接true。

注意，如果destDir在Javadoc Plugin配置中设置了javadocDir参数，还需要将JXR Plugin的参数设置到同一目录下。