Maven 2 Javadoc 插件

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

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

#${project.reporting.outputDirectory}/apidocs/javadoc.exe(or .sh) \
    @options @packages | @argfile

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

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

目标概述

Javadoc 插件有六个目标：

  • javadoc:javadoc 为项目生成 Javadoc 文件。它执行标准的 Javadoc 工具并支持该工具使用的参数。
  • javadoc:test-javadoc 为项目生成测试 Javadoc 文件。它执行标准的 Javadoc 工具并支持该工具使用的参数。
  • javadoc:aggregate 为聚合器项目生成 Javadoc 文件。它执行标准的 Javadoc 工具并支持该工具使用的参数。
  • javadoc:test-aggregate 为聚合器项目生成测试 Javadoc 文件。它执行标准的 Javadoc 工具并支持该工具使用的参数。
  • javadoc:jar 创建生成的 Javadocs 的存档文件。它在发布过程中用于为项目的发布创建 Javadoc 工件。该工件与项目的已编译二进制文件和源存档一起上传到远程存储库。
  • javadoc:test-jar 创建生成的测试 Javadocs 的存档文件。

用法

可以在此处找到有关如何使用 Javadoc 插件的说明 。

例子

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