此插件可用的目标:
| 目标 | 报告? | 描述 |
|---|---|---|
| javadoc:聚合 | 是的 | 使用标准Javadoc ToolJava code在
聚合器项目中生成文档。 |
| javadoc:帮助 | 不 | 显示有关 maven-javadoc-plugin 的帮助信息。 称呼 mvn javadoc:help -Ddetail=true -Dgoal=<goal-name>显示参数详细信息。 |
| javadoc:jar | 不 | 将主要源代码的 Javadoc 文档捆绑到 jar 中。
注意:该 aggregate参数始终设置为
false。 |
| javadoc:javadoc | 是的 | Java code使用标准Javadoc Tool为项目中的生成文档。 |
| javadoc:测试聚合 | 是的 | 使用标准Javadoc ToolJava Test code在
聚合器项目中生成文档。 |
| javadoc:测试罐 | 不 | 将用于测试源的 Javadoc 文档捆绑在 jar 中。 注意:该 aggregate参数始终设置为
false。 |
| javadoc:test-javadoc | 是的 | Java Test code使用标准Javadoc Tool为项目中的生成文档。 |
以下指定了运行此 Maven 插件的最低要求:
| maven | 2.0.9 |
| JDK | 1.4 |
| 记忆 | 没有最低要求。 |
| 磁盘空间 | 没有最低要求。 |
您应该在项目的插件配置中指定版本:
<project>
...
<build>
<!-- To define the plugin version in your parent POM -->
<pluginManagement>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>2.5</version>
</plugin>
...
</plugins>
</pluginManagement>
<!-- To use the plugin goals in your POM or parent POM -->
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>2.5</version>
</plugin>
...
</plugins>
</build>
...
<!-- To use the report goals in your POM or parent POM -->
<reporting>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>2.5</version>
</plugin>
...
</plugins>
</reporting>
...
</project>
有关详细信息,请参阅“配置插件指南”