Apache Maven Javadoc 插件

Javadoc 插件使用 Javadoc 工具为指定项目生成 javadocs。有关标准 Javadoc 工具的更多信息，请参阅参考指南。

Javadoc 插件从 pom.xml 中指定的插件配置中获取将使用的参数值。为了保存所有 javadoc 参数、包或文件，Javadoc 插件生成参数文件并调用 Javadoc 工具，如下所示：

javadoc.exe(or .sh) @options @packages | @argfile

当没有设置配置值时，插件会设置默认值，然后执行 Javadoc 工具。

您还可以使用该插件将生成的 javadocs 打包成 jar 文件进行分发。

目标概述

Javadoc 插件有 16 个目标：

  • javadoc:javadoc为项目生成 Javadoc 文件。它执行标准的 Javadoc 工具并支持该工具使用的参数。
  • javadoc:test-javadoc为项目生成测试 Javadoc 文件。它执行标准的 Javadoc 工具并支持该工具使用的参数。
  • javadoc:javadoc-no-fork为项目生成 Javadoc 文件。它执行标准的 Javadoc 工具并支持该工具使用的参数，而无需再次分叉generate-sources阶段。请注意，此目标确实需要在站点生成之前生成测试源，例如通过调用mvn clean deploy site。
  • javadoc:test-javadoc-no-fork为项目生成测试 Javadoc 文件。它执行标准的 Javadoc 工具并支持该工具使用的参数，而无需再次分叉generate-test-sources阶段。请注意，此目标确实需要在站点生成之前生成测试源，例如通过调用mvn clean deploy site。
  • javadoc:aggregate为聚合器项目生成 Javadoc 文件。它执行标准的 Javadoc 工具并支持该工具使用的参数。
  • javadoc:test-aggregate为聚合器项目生成测试 Javadoc 文件。它执行标准的 Javadoc 工具并支持该工具使用的参数。
  • javadoc:aggregate-no-fork为聚合器项目生成 Javadoc 文件。它执行标准的 Javadoc 工具并支持该工具使用的参数，而无需再次分叉compile > 阶段。请注意，此目标确实需要在站点生成之前生成类文件，例如通过调用mvn compile或mvn install。
  • javadoc:test-aggregate为聚合器项目生成测试 Javadoc 文件。它执行标准的 Javadoc 工具并支持工具使用的参数，而无需再次分叉编译阶段。请注意，此目标确实需要在站点生成之前生成测试类文件，例如通过调用mvn test-compile或mvn install。
  • javadoc:jar创建生成的 Javadocs 的存档文件。它在发布过程中用于为项目的发布创建 Javadoc 工件。该工件与项目的已编译二进制文件和源存档一起上传到远程存储库。
  • javadoc:test-jar创建生成的测试 Javadocs 的存档文件。
  • javadoc:aggregate-jar为聚合器项目创建生成的 Javadocs 的存档文件。
  • javadoc:test-aggregate-jar为聚合器项目创建生成的测试 Javadocs 的存档文件。
  • javadoc:fix是一个交互式目标，用于修复 Java 文件的 Javadoc 文档和标签。
  • javadoc:test-fix是一个交互式目标，用于修复 Javadoc 文档和测试 Java 文件的标签。
  • javadoc:resource-bundle将javadocDirectory与 Javadoc 配置选项（例如 taglet、doclet 和链接信息）捆绑到可部署的工件中。
  • javadoc:test-resource-bundle将testJavadocDirectory与 Javadoc 配置选项（例如 taglet、doclet 和链接信息）捆绑到可部署的工件中。

用法

有关如何使用 Javadoc 插件的一般说明可以在使用页面上找到。下面给出的示例中描述了一些更具体的用例。

如果您对插件的使用仍有疑问，请查看常见问题解答并随时联系用户邮件列表。邮件列表中的帖子已存档，并且可能已经包含您问题的答案，作为旧线程的一部分。因此，也值得浏览/搜索邮件存档。

如果您觉得插件缺少功能或存在缺陷，您可以在我们的问题跟踪器中填写功能请求或错误报告。创建新问题时，请提供您所关注问题的全面描述。特别是对于修复错误，开发人员可以重现您的问题至关重要。出于这个原因，非常感谢附在问题上的整个调试日志、POM 或最好的小演示项目。当然，补丁也是受欢迎的。贡献者可以从我们的源代码库中查看该项目，并将在帮助使用 Maven 的指南中找到补充信息。

例子

以下示例展示了如何在更高级的用例中使用 Javadoc 插件：