使用备用 Javadoc 工具

使用备用 Javadoc 可执行文件

默认情况下，Maven Javadoc 插件尝试从 Java 属性java.home或环境变量JAVA_HOME自动检测 Javadoc Tool 可执行文件。

您还可以指定 Javadoc 工具的可执行文件以与<javadocExecutable/>参数一起使用。例如：

<project>
  ...
  <reporting> (or <build>)
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-javadoc-plugin</artifactId>
        <version>3.3.2</version>
        <configuration>
          <javadocExecutable>C:\jdk1.6.0\bin\javadoc.exe</javadocExecutable>
          ...
        </configuration>
      </plugin>
      ...
    </plugins>
  </reporting> (or </build>)
  ...
</project>

重要提示：通过使用<javadocExecutable/>参数，构建将依赖于平台！一个好的做法是定义一个环境变量（即 JAVA_1.6_HOME），因此您可以指定它：（即 <javadocExecutable>${env.JAVA_1.6_HOME}/bin/javadoc</javadocExecutable>）。另一种方法是使用 <project><properties/></project> 定义 POM 属性。

使用备用 Javadoc 版本

同样，Maven Javadoc 插件尝试通过调用javadoc -J-fullversion来自动检测 Javadoc 工具版本。

您还可以指定 Javadoc Tool 可执行文件的版本。例如：

<project>
  ...
  <reporting> (or <build>)
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-javadoc-plugin</artifactId>
        <version>3.3.2</version>
        <configuration>
          <javadocVersion>1.5</javadocVersion>
          ...
        </configuration>
      </plugin>
      ...
    </plugins>
  </reporting> (or </build>)
  ...
</project>

注意：如果指定的javadocVersion与 Javadoc Tool 可执行文件不同，您可能会收到警告。