此插件可用的目标:
| 目标 | 报告? | 描述 |
|---|---|---|
| javadoc:聚合 | 是的 | 使用标准Javadoc Tool 从 3.1.0 版开始,会为 Maven 多模块项目的每个模块创建一个汇总报告。 |
| javadoc:聚合罐 | 不 | 使用标准Javadoc Tool将聚合器 从 3.1.0 版本开始,为 Maven 多模块项目的每个模块创建了一个聚合 jar。 |
| javadoc:聚合无分叉 | 是的 | 使用标准Javadoc ToolJava code在
聚合器项目中生成文档。 |
| javadoc:修复 | 不 | 修复项目的 Javadoc 文档和标签Java code
。请参阅可以在哪里使用标签。 |
| javadoc:帮助 | 不 | 显示有关 maven-javadoc-plugin 的帮助信息。 调用 mvn javadoc:help -Ddetail=true
-Dgoal=<goal-name>以显示参数详细信息。 |
| javadoc:jar | 不 | 使用标准Javadoc Tool将NON 聚合器main Java code项目
中的 Javadoc 文档捆绑到 jar 中
。 |
| javadoc:javadoc | 是的 | 使用标准Javadoc ToolJava code在NON 聚合器项目中生成文档。 |
| javadoc:javadoc-no-fork | 是的 | 使用标准Javadoc ToolJava code在NON 聚合器项目中生成文档。请注意,此目标确实需要在站点生成之前生成源,例如通过调用.mvn clean deploy
site |
| javadoc:资源包 | 不 | BundleAbstractJavadocMojo.javadocDirectory以及 javadoc 配置选项(例如 taglet、doclet 和链接信息)到可部署的工件中。这个工件可以在被
includeDependencySources选项使用时被 javadoc 插件 mojos 使用,以生成与原始项目本身生成的 javadoc 有点一致的 javadoc。 |
| javadoc:测试聚合 | 是的 | 使用标准Javadoc Tool 从 3.1.0 版开始,会为 Maven 多模块项目的每个模块创建一个汇总报告。 |
| javadoc:测试聚合罐 | 不 | 使用标准Javadoc Tool将聚合器 从 3.1.0 版本开始,为 Maven 多模块项目的每个模块创建了一个聚合 jar。 |
| javadoc:test-aggregate-no-fork | 是的 | 使用标准Javadoc ToolJava Test code在
聚合器项目中生成文档。 |
| javadoc:测试修复 | 不 | 修复项目的 Javadoc 文档和标签Test Java
code。请参阅可以在哪里使用标签。 |
| javadoc:测试罐 | 不 | 使用标准Javadoc Tool将NON 聚合器test Java code项目
中的 Javadoc 文档捆绑到 jar 中
。 |
| javadoc:test-javadoc | 是的 | 使用标准Javadoc ToolJava Test code在
NON 聚合器项目中生成文档。 |
| javadoc:test-javadoc-no-fork | 是的 | 使用标准Javadoc ToolJava Test code在
NON 聚合器项目中生成文档。请注意,此目标确实需要在站点生成之前生成测试源,例如通过调用.mvn clean
deploy site |
| javadoc:测试资源包 | 不 | BundleTestJavadocJar.testJavadocDirectory以及 javadoc 配置选项(AbstractJavadocMojo
例如 taglet、doclet 和链接信息)到可部署的工件中。这个工件可以在被includeDependencySources
选项使用时被 javadoc 插件 mojos 使用,以生成与原始项目本身生成的 javadoc 有点一致的 javadoc。 |
您应该在项目的插件配置中指定版本:
<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>3.3.2</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>3.3.2</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>3.3.2</version>
</plugin>
...
</plugins>
</reporting>
...
</project>
有关详细信息,请参阅“配置插件指南”