javadoc：测试聚合罐

全名：

org.apache.maven.plugins:maven-javadoc-plugin:2.8.1:test-aggregate-jar

说明：

使用标准Javadoc Tool 将聚合器项目中Java 测试代码的 Javadoc 文档捆绑到 jar 中。

属性：

  • 需要执行一个 Maven 项目。
  • 作为聚合器插件执行。
  • 需要对范围内的工件进行依赖解析：test。
  • 自版本：2.6。
  • 默认绑定到生命周期阶段：package。

必需参数

姓名 类型 自从 描述
输出目录 文件 2.6 指定 Javadoc 保存生成的 HTML 文件的目标目录。
见d。

默认值为：${project.build.directory}/testapidocs。

可选参数

姓名 类型 自从 描述
附加选项 细绳 2.3 在命令行上设置一个附加的 Javadoc 选项（即 JVM 选项）。例子： 

<additionalJOption>-J-Xss128m</additionalJOption>
请参阅Jflag。
请参阅vmoptions。
请参阅网络属性。
附加参数 细绳 2.6 在命令行上设置附加参数。对于包含空格的参数，此值应包含必要的引号。对于自定义 doclet 很有用。
附加依赖项 列表 2.8.1 向 javadoc 类路径添加可选依赖项的能力。示例： 
<additionnalDependencies>
  <additionnalDependency>
    <groupId>geronimo-spec</groupId>
    <artifactId>geronimo-spec-jta</artifactId>
    <version>1.0.1B-rc4:</version>
  </additionnalDependency>
</additionnalDependencies>

总计的 布尔值 2.6 已弃用。从2.5开始。请改用目标javadoc:aggregate和 javadoc:test-aggregate。
默认值为：false。
档案 Maven存档配置 2.5 要使用的存档配置。请参阅Maven 存档器参考。
附 布尔值 2.6 指定是否将生成的工件附加到项目助手。

默认值为：true。
作者 布尔值 2.6 指定作者文本是否包含在生成的 Javadocs 中。
见作者。

默认值为：true。
引导类路径 细绳 2.5 指定引导类所在的路径。bootclasspath 可以包含多个路径，方法是用冒号 ( :)或分号 ( ; )分隔它们。
请参阅引导类路径。

引导类路径工件 引导类路径Artifact[] 2.5 指定引导类所在的工件。
请参阅引导类路径。
例子： 
<bootclasspathArtifacts>
  <bootclasspathArtifact>
    <groupId>my-groupId</groupId>
    <artifactId>my-artifactId</artifactId>
    <version>my-version</version>
  </bootclasspathArtifact>
</bootclasspathArtifacts>

请参阅Javadoc。

底部 细绳 2.6 指定要放置在每个输出文件底部的文本。
如果你想使用 html 你必须把它放在一个 CDATA 部分，
例如。<![CDATA[版权所有 2005，<a href="http://www.mycompany.com">MyCompany, Inc.<a>]]>
见底部。

默认值为：版权 © {inceptionYear}-{currentYear} {organizationName}。版权所有。.
破坏者 布尔值 2.6 使用断句迭代器来确定第一句的结尾。
请参阅breakiterator。
从Java 1.4 开始。

默认值为：false。
字符集 细绳 2.6 指定此文档的 HTML 字符集。如果未指定，则字符集值将是 docencoding参数的值。
请参阅字符集。

调试 布尔值 2.1 将此设置为true以调试 Javadoc 插件。这样，在输出目录中提供了javadoc.bat(or.sh)、options、 @packages或argfile文件。

默认值为：false。
依赖源排除 列表 2.7 排除的依赖源模式列表。示例： org.apache.maven.shared:*
依赖源包括 列表 2.7 包含的依赖源模式列表。示例： org.apache.maven:*
目标目录 文件 2.6 指定 javadoc 保存生成的 HTML 文件的目标目录。见d。
检测JavaApiLink 布尔值 2.6 检测当前构建的 Java API 链接，即 Java 源 1.4 的http://download.oracle.com/javase/1.4.2/docs/api/。
默认情况下，目标根据org.apache.maven.plugins:maven-compiler-plugin （在${project.build.plugins}或 ${project.build中 定义）中源参数 的值检测 Javadoc API 链接.pluginManagement}），或尝试从javadocExecutable版本计算它。 有关默认值，请参阅Javadoc 。默认值为：true。
检测链接 布尔值 2.6 检测项目中定义的所有依赖项的 Javadoc 链接。检测基于默认的 Maven 约定，即：${project.url}/apidocs。
例如，如果项目依赖于Apache Commons Lang ， 即： 
<dependency>
  <groupId>commons-lang</groupId>
  <artifactId>commons-lang</artifactId>
</dependency>
添加的 Javadoc -link参数将为 http://commons.apache.org/lang/apidocs。
默认值为：false。
检测离线链接 布尔值 2.6 检测项目中定义的所有模块的链接。
如果reactorProjects以非聚合方式定义，它会根据定义的项目的 url 在模块之间生成默认的离线链接。例如，如果父项目有两个项目module1和module2，则 -linkoffline将为：为module1
添加的 Javadoc -linkoffline参数 将为 /absolute/path/to/ module2 /target/site/apidocs 添加的 Javadoc -linkoffline参数对于 module2将是 /absolute/path/to/ module1 /target/site/apidocs

默认值为：true。
文件编码 细绳 2.6 指定生成的 HTML 文件的编码。如果未指定，则文档编码值将为UTF-8。
请参阅文档编码。
默认值为：${project.reporting.outputEncoding}。
文档文件子目录 布尔值 2.6 启用从 javadocDirectory目录（例如 src/main/javadoc/com/mycompany/myapp/doc-files和 src/main/javadoc/resources）深度复制**/doc-files目录和特定资源目录。 请参阅docfilessubdirs。 从Java 1.4 开始。 请参阅javadocDirectory。默认值为：false。
文档集 细绳 2.6 指定启动用于生成文档的 doclet 的类文件。
请参阅doclet。
docletArtifact DocletArtifact 2.6 指定包含 doclet 起始类文件的工件（使用-doclet选项指定）。
请参阅docletpath。
例子： 
<docletArtifact>
  <groupId>com.sun.tools.doclets</groupId>
  <artifactId>doccheck</artifactId>
  <version>1.2b2</version>
</docletArtifact>

请参阅Javadoc。

docletArtifacts DocletArtifact[] 2.1 指定包含 doclet 起始类文件的路径的多个工件（使用-doclet 选项指定）。
请参阅docletpath。
例子： 
<docletArtifacts>
  <docletArtifact>
    <groupId>com.sun.tools.doclets</groupId>
    <artifactId>doccheck</artifactId>
    <version>1.2b2</version>
  </docletArtifact>
</docletArtifacts>

请参阅Javadoc。

docletPath 细绳 2.6 指定 doclet 起始类文件（使用-doclet选项指定）及其依赖的任何 jar 文件的路径。docletPath可以包含多个路径，方法是用冒号 ( : ) 或分号 ( ; )分隔它们。
请参阅docletpath。
文件名 细绳 2.6 指定要放置在概览摘要文件顶部附近的标题。
见文档标题。

默认值为：${project.name} ${project.version} API。
编码 细绳 2.6 指定源文件的编码名称。如果未指定，则编码值将是 file.encoding系统属性的值。
请参阅编码。
注意：在 2.4 中，默认值被锁定为 ISO-8859-1以确保重现构建，但在 2.5 中恢复了这一点。

默认值为：${project.build.sourceEncoding}。
excludePackageNames 细绳 2.6 从-subpackages形成的列表中无条件地排除指定的包及其子包。多个包可以用逗号 ( , )、冒号 (:)或分号 ( ; ) 分隔。
例子： 

<excludePackageNames>*.internal:org.acme.exclude1.*:org.acme.exclude2</excludePackageNames>

请参阅排除。
从Java 1.4 开始。
排除的ocfiles子目录 细绳 2.6 排除任何具有给定名称的“doc-files”子目录。可以通过用冒号 ( : )分隔多个模式来排除它们。
请参阅excludeocfilessubdir。
从Java 1.4 开始。
扩展目录 细绳 2.6 指定扩展类所在的目录。使用冒号 ( :)或分号 ( ; )分隔extdirs中的目录。 请参阅extdirs。
失败错误 布尔值 2.5 指定如果在 javadoc 执行期间出现错误，构建是否会失败。
默认值为：true。
最终名称 细绳 2.6 指定将用于生成的 jar 文件的文件名。请注意-javadoc或 -test-javadoc将附加到文件名。
页脚 细绳 2.6 指定要放置在每个输出文件底部的页脚文本。
见页脚。
团体 团体[] 2.6 将概览页面上的包分成您指定的任何组，每个表一组。包模式可以是任何包名称，也可以是任何包名称的开头，后跟星号 ( * )，意思是“匹配任何字符”。多个模式可以包含在一个组中，方法是用冒号 (:) 分隔它们。
例子： 
<groups>
  <group>
    <title>Core Packages</title>
    <!-- To includes java.lang, java.lang.ref,
    java.lang.reflect and only java.util
    (i.e. not java.util.jar) -->
    <packages>java.lang*:java.util</packages>
  </group>
  <group>
    <title>Extension Packages</title>
     <!-- To include javax.accessibility,
    javax.crypto, ... (among others) -->
    <packages>javax.*</packages>
  </group>
</groups>
注意：对 包使用java.lang.*会省略java.lang包，但使用java.lang*会包含它。 见组。 请参阅Javadoc。



标题 细绳 2.6 指定要放置在每个输出文件顶部的标题文本。
见标题。
帮助文件 细绳 2.6 指定顶部和底部导航栏中的帮助链接链接到的备用帮助文件路径\文件名的路径。
注意：可能与 <nohelp/> 冲突。帮助文件可以是绝对文件路径
。 从 2.6 开始，它也可以是来自当前项目源目录中的资源（即 src/main/java、src/main/resources或 src/main/javadoc）或来自 Javadoc 插件依赖项中的资源的路径，例如实例： 

<helpfile>path/to/your/resource/yourhelp-doc.html</helpfile>
path/to/your/resource/ yourhelp -doc.html可能在src/main/javadoc中。 
<构建>
  <插件>
    <插件>
      <groupId>org.apache.maven.plugins</groupId>
      <artifactId>maven-javadoc-plugin</artifactId>
      <配置>
        

<helpfile>path/to/your/resource/yourhelp-doc.html</helpfile>
        ...
      </配置>
      <依赖项>
        <依赖>
          <groupId>groupId</groupId>
          <artifactId>artifactId</artifactId>
          <版本>版本</版本>
        </依赖>
      </依赖>
    </插件>
    ...
  <插件>
</build>
其中path/to/your/resource/yourhelp-doc.html在groupId:artifactId:version javadoc 插件依赖项中定义。
请参阅帮助文件。
包括依赖源 布尔值 2.7 是否应解析依赖源 jar 并将其包含为 javadoc 生成的源路径。这在为分发项目创建 javadocs 时很有用。
默认值为：false。
包括TransitiveDependencySources 布尔值 2.7 是否在要包含在此 javadoc 运行中的依赖源 jar 列表中包含传递依赖项。
默认值为：false。
jar输出目录 细绳 2.6 指定将放置生成的 jar 文件的目录。
javaApiLinks 特性 2.6 仅当Sun Javadoc API url 已更改或为 Javadoc API url 使用自定义 url时才使用此参数。
有关默认值，请参阅Javadoc 。
javadoc目录 文件 2.1 指定要包含在 Javadoc 中的 Javadoc 资源目录（即 package.html、images...）。
可以与docfilessubdirs 参数一起使用。
请参阅docfilessubdirs。
javadoc可执行文件 细绳 2.3 设置要使用的 Javadoc Tool 可执行文件的绝对路径。从 2.5 版开始，仅仅一个目录规范就足以让插件分别使用该目录中的“javadoc”或“javadoc.exe”。
javadoc版本 细绳 2.3 要使用的 Javadoc 工具可执行文件的版本，例如。“1.3”、“1.5”。
关键词 布尔值 2.1 将 HTML 元关键字标签添加到每个类的生成文件中。
见关键字。
从Java 1.4.2 开始。
从Java 5.0 开始。

默认值为：false。
链接 数组列表 2.6 创建指向现有 javadoc 生成的外部引用类文档的链接。
备注：
  1. 仅在isOffline设置为 false时使用。
  2. 所有给定的链接都应该有一个可 获取的/package-list文件。例如： 
    <links>
  <link>http://download.oracle.com/javase/1.4.2/docs/api</link>
<links>
    将被使用，因为 http://download.oracle.com/javase/1.4.2/docs/api/package-list 存在。
  3. 如果定义了detectLinks，则会自动添加项目依赖项之间的链接。
  4. 如果定义了detectJavaApiLink，将自动添加一个基于项目源的Java版本的Java API链接。
见链接。
链接源 布尔值 2.6 创建每个源文件的 HTML 版本（带有行号）并从标准 HTML 文档添加指向它们的链接。
见链接源。
从Java 1.4 开始。

默认值为：false。
本地存储库 工件存储库 2.6 工件所在的本地存储库。
语言环境 细绳 2.6 指定 javadoc 在生成文档时使用的语言环境。
请参阅语言环境。
最大内存 细绳 2.6 指定启动 Javadoc 工具时要使用的最大 Java 堆大小。JVM 将此属性称为-Xmx 参数。示例：“512”或“512m”。内存单元取决于使用的 JVM。支持的单位可以是：k、 kb、m、mb、g、 gb、t、tb。如果未指定单位，则默认单位为m。
最小内存 细绳 2.6 指定启动 Javadoc 工具时要使用的最小 Java 堆大小。JVM 将此属性称为-Xms 参数。示例：“512”或“512m”。内存单元取决于使用的 JVM。支持的单位可以是：k、 kb、m、mb、g、 gb、t、tb。如果未指定单位，则默认单位为m。
没有意见 布尔值 2.6 抑制整个评论正文，包括主要描述和所有标签，只生成声明。
见无评论。
从Java 1.4 开始。

默认值为：false。
节点不推荐 布尔值 2.6 防止在文档中生成任何已弃用的 API。
请参阅nodeprecated。

默认值为：false。
节点precatedlist 布尔值 2.6 防止生成包含已弃用 API 列表 (deprecated-list.html) 和导航栏中指向该页面的链接的文件。
请参阅nodeprecatedlist。

默认值为：false。
无助 布尔值 2.6 省略每个输出页面顶部和底部导航栏中的帮助链接。
注意：可能与 <helpfile/> 冲突。
请参阅无帮助。

默认值为：false。
无索引 布尔值 2.6 从生成的文档中省略索引。
注意：可能与 <splitindex/> 冲突。
见noindex。

默认值为：false。
非avbar 布尔值 2.6 从生成的文档中省略导航栏。
请参阅nonavbar。

默认值为：false。
概览 布尔值 2.4 从生成的文档中省略整个概述页面。
注意：可能与 <overview/> 冲突。
标准 Doclet 无证选项。

默认值为：false。
无限定词 细绳 2.6 在输出中的类名之前省略合格的包名。例子： 
<noqualifier>all</noqualifier>
or
<noqualifier>packagename1:packagename2</noqualifier>
请参阅noqualifier。
从Java 1.4 开始。
诺斯 布尔值 2.6 从生成的文档中省略与 since 标签关联的“Since”部分。
见诺辛。

默认值为：false。
时间戳 布尔值 2.1 抑制时间戳，它隐藏在每个页面顶部附近生成的 HTML 中的 HTML 注释中。
见nottimestamp。
从Java 5.0 开始。

默认值为：false。
诺特里 布尔值 2.6 从生成的文档中省略类/接口层次结构页面。
见注。

默认值为：false。
离线链接 离线链接[] 2.6 此选项是-link的变体；它们都为外部引用的类创建指向 javadoc 生成的文档的链接。
见链接离线。
例子： 
<offlineLinks>
  <offlineLink>
    <url>http://download.oracle.com/javase/1.5.0/docs/api/</url>
    <location>../javadoc/jdk-5.0/</location>
  </offlineLink>
</offlineLinks>

注意：如果定义了detectOfflineLinks，则如果目标以非聚合器方式调用，则会自动添加项目模块之间的离线链接。
请参阅Javadoc。

老的 布尔值 2.6 此选项使用 Javadoc 1.1 生成的文档的外观和功能创建文档。
见1.1。

默认值为：false。
概述 文件 2.6 指定 javadoc 应从路径/文件名指定的“源”文件中检索概述文档的文本并将其放置在概述页面 (overview-summary.html) 上。
注意：可能与 <nooverview/> 冲突。
请参阅概述。

默认值为：${basedir}/src/main/javadoc/overview.html。
包头 细绳 2.1 指定左上框架的文本。
从Java 1.4.2 开始。
代理主机 细绳 2.6 已弃用。从 2.4 开始。而不是在 settings.xml中配置活动代理主机。
代理端口 整数 2.6 已弃用。从 2.4 开始。而不是在 settings.xml中配置活动代理端口。
安静的 布尔值 2.6 关闭非错误和非警告消息，只留下警告和错误出现，使其更易于查看。
注意：是 Java 1.4.2 中的标准 doclet（请参阅错误 ID 4714350）。
见静。
从 Java 5.0 开始。

默认值为：false。
远程存储库 列表 2.6 工件所在的远程存储库。
资源Artifacts 资源神器[] 2.5 包含应复制到 Javadoc 输出目录（如样式表、图标等）的资源的工件列表。
例子： 
<resourcesArtifacts>
  <resourcesArtifact>
    <groupId>external.group.id</groupId>
    <artifactId>external-resources</artifactId>
    <version>1.0</version>
  </resourcesArtifact>
</resourcesArtifacts>

请参阅Javadoc。

串行警告 布尔值 2.6 为缺少的串行标签生成编译时警告。
请参阅serialwarn

默认值为：false。
显示 细绳 2.6 指定要在 Javadocs 中显示的类和成员的访问级别。可能的值为：
  • public （仅显示公共类和成员）
  • protected （仅显示公共和受保护的类和成员）
  • 包 （显示所有未标记为私有的类和成员）
  • 私有 （显示所有类和成员）


默认值为：受保护。
跳过 布尔值 2.5 指定是否应跳过 Javadoc 生成。
默认值为：false。
资源 细绳 2.6 需要使 javadoc 能够处理 J2SE v 1.4 源代码中引入的断言或 J2SE v5 中引入的泛型。
见源。
从Java 1.4 开始。
sourceDependencyCacheDir 文件 2.7 解压后的项目源/测试源应该被缓存的目录。
默认值为：${project.build.directory}/distro-javadoc-sources。
源路径 细绳 2.6 指定子包所在的源路径。源路径可以包含多个路径，方法是用冒号( :)或分号 ( ; )分隔它们。
请参阅源路径。
源标签 整数 2.1 指定每个选项卡在源中占用的空格数。如果源中没有使用制表符，则使用默认空间。
注意：是Java 1.4.2 中的linksourcetab（请参阅错误 ID 4788919）。
从1.4.2 开始。
从 Java 5.0 开始。
拆分索引 布尔值 2.6 将索引文件拆分为多个文件，按字母顺序，每个字母一个文件，再加上一个用于任何以非字母字符开头的索引条目的文件。
注意：可能与 <noindex/> 冲突。
请参阅拆分索引。

默认值为：false。
样式表 细绳 2.6 当未指定stylesheetfile参数时，指定要使用的样式表是 maven的 javadoc 样式表还是java的默认样式表。 可能的值：maven或java。默认值为：java。
样式表文件 细绳 2.6 指定备用 HTML 样式表文件的路径。样式表
文件可以是绝对文件路径。 从 2.6 开始，它也可以是来自当前项目源目录中的资源（即 src/main/java、src/main/resources或 src/main/javadoc）或来自 Javadoc 插件依赖项中的资源的路径，例如实例： 

<stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile>
path/to/your/resource/yourstylesheet.css 可能位于src/main/javadoc中。 
<构建>
  <插件>
    <插件>
      <groupId>org.apache.maven.plugins</groupId>
      <artifactId>maven-javadoc-plugin</artifactId>
      <配置>
        

<stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile>
        ...
      </配置>
      <依赖项>
        <依赖>
          <groupId>groupId</groupId>
          <artifactId>artifactId</artifactId>
          <版本>版本</版本>
        </依赖>
      </依赖>
    </插件>
    ...
  <插件>
</build>
其中path/to/your/resource/yourstylesheet.css在groupId:artifactId:version javadoc 插件依赖项中定义。
请参阅样式表文件。
子包 细绳 2.6 指定将执行 javadoc 的包目录。多个包可以用冒号 ( : ) 分隔。
请参阅子包。
从Java 1.4 开始。
小标签 细绳 2.6 指定启动用于生成该标记的文档的标记的类文件。
见小标签。
从Java 1.4 开始。
tagletArtifact TagletArtifact 2.1 指定包含 taglet 类文件 (.class) 的 Taglet 工件。
请参阅标记路径。
例子： 
<taglets>
  <taglet>
    <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass>
  </taglet>
  <taglet>
    <tagletClass>package.to.AnotherTagletClass</tagletClass>
  </taglet>
  ...
</taglets>
<tagletArtifact>
  <groupId>group-Taglet</groupId>
  <artifactId>artifact-Taglet</artifactId>
  <version>version-Taglet</version>
</tagletArtifact>

请参阅Javadoc。

tagletArtifacts TagletArtifact[] 2.5 指定几个包含 taglet 类文件 (.class) 的 Taglet 工件。这些 taglets 类名将被自动检测，因此无需指定它们。
见小标签。
请参阅标记路径。
例子： 
<tagletArtifacts>
  <tagletArtifact>
    <groupId>group-Taglet</groupId>
    <artifactId>artifact-Taglet</artifactId>
    <version>version-Taglet</version>
  </tagletArtifact>
  ...
</tagletArtifacts>

请参阅Javadoc。

标记路径 细绳 2.6 指定用于查找 taglet 类文件 (.class) 的搜索路径。tagletpath可以包含多个路径，方法是用冒号 ( : ) 或分号 ( ; )分隔它们。
请参阅标记路径。
从Java 1.4 开始。
小标签 标签[] 2.1 使 Javadoc 工具能够解释多个 taglet。
见小标签。
请参阅标记路径。
例子： 
<taglets>
  <taglet>
    <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass>
    <!--<tagletpath>/home/taglets</tagletpath>-->
    <tagletArtifact>
      <groupId>group-Taglet</groupId>
      <artifactId>artifact-Taglet</artifactId>
      <version>version-Taglet</version>
    </tagletArtifact>
  </taglet>
</taglets>

请参阅Javadoc。

标签 标签[] 2.6 使 Javadoc 工具能够解释文档注释中的简单、单参数自定义块标记标记名。
见标签。
从Java 1.4 开始。
例子： 
<tags>
  <tag>
    <name>todo</name>
    <placement>a</placement>
    <head>To Do:</head>
  </tag>
</tags>
注意：位置应该是 Xaoptcmf 字母的组合：
  • X（禁用标签）
  • 一个（全部）
  • o（概述）
  • p（包）
  • t（类型，即类和接口）
  • c（构造函数）
  • 米（方法）
  • f（字段）
请参阅Javadoc。

测试文档标题 细绳 2.5 指定要放置在概览摘要文件顶部附近的测试标题。
见文档标题。

默认值为：${project.name} ${project.version} 测试 API。
testJavadoc目录 文件 2.5 指定要包含在 Javadoc 中的 Test Javadoc 资源目录（即 package.html、images...）。
测试概述 文件 2.5 指定 Javadoc 应从路径/文件名指定的“源”文件中检索测试概述文档的文本，并将其放置在概述页面 (overview-summary.html) 上。
请参阅概述。

默认值为：${basedir}/src/test/javadoc/overview.html。
测试窗口标题 细绳 2.5 指定要放置在 HTML 标题标签中的测试标题。
见窗口标题。

默认值为：${project.name} ${project.version} 测试 API。
最佳 细绳 2.4 指定要放置在每个输出文件顶部的顶部文本。
见6227616。
从 Java 6.0 开始
采用 布尔值 2.6 每个记录的类和包都包括一个“使用”页面。
见使用。

默认值为：true。
使用默认清单文件 布尔值 2.5 将此设置为true以启用 defaultManifestFile。

默认值为：false。
使用标准 Doclet 选项 布尔值 2.5 指定将标准 Doclet 提供的选项用于自定义 doclet。
例子： 
<docletArtifacts>
  <docletArtifact>
    <groupId>com.sun.tools.doclets</groupId>
    <artifactId>doccheck</artifactId>
    <version>1.2b2</version>
  </docletArtifact>
</docletArtifacts>
<useStandardDocletOptions>真</useStandardDocletOptions>

默认值为：true。
验证链接 布尔值 2.8 控制包列表 资源的内容验证的标志。如果设置， 将验证包列表资源的内容。
默认值为：false。
冗长的 布尔值 2.6 在 javadoc 运行时提供更详细的消息。
见详细。

默认值为：false。
版本 布尔值 2.6 在生成的文档中包含版本文本。
见版本。

默认值为：true。
窗口标题 细绳 2.6 指定要放置在 HTML 标题标签中的标题。
见窗口标题。

默认值为：${project.name} ${project.version} API。

参数详情

附加选项：

在命令行上设置一个附加的 Javadoc 选项（即 JVM 选项）。例子： 

<additionalJOption>-J-Xss128m</additionalJOption>
请参阅Jflag。
请参阅vmoptions。
请参阅网络属性。
  • 类型：java.lang.String
  • 从: 2.3
  • 要求：否
  • 表达式：${additionalJOption}

附加参数：

在命令行上设置附加参数。对于包含空格的参数，此值应包含必要的引号。对于自定义 doclet 很有用。
  • 类型：java.lang.String
  • 从: 2.6
  • 要求：否
  • 表达式：${additionalparam}

附加依赖项：

向 javadoc 类路径添加可选依赖项的能力。示例： 
<additionnalDependencies>
  <additionnalDependency>
    <groupId>geronimo-spec</groupId>
    <artifactId>geronimo-spec-jta</artifactId>
    <version>1.0.1B-rc4:</version>
  </additionnalDependency>
</additionnalDependencies>
  • 类型：java.util.List
  • 从: 2.8.1
  • 要求：否

聚合：

已弃用。从2.5开始。请改用目标javadoc:aggregate和 javadoc:test-aggregate。
是在根目录构建聚合报告，还是构建单独的报告。
  • 类型：布尔值
  • 从: 2.6
  • 要求：否
  • 表达式：${聚合}
  • 默认值：假

存档：

要使用的存档配置。请参阅Maven 存档器参考。
  • 类型：org.apache.maven.archiver.MavenArchiveConfiguration
  • 从: 2.5
  • 要求：否

附上：

指定是否将生成的工件附加到项目助手。
  • 类型：布尔值
  • 从: 2.6
  • 要求：否
  • 表达式：${attach}
  • 默认值：真

作者：

指定作者文本是否包含在生成的 Javadocs 中。
见作者。
  • 类型：布尔值
  • 从: 2.6
  • 要求：否
  • 表达式：${作者}
  • 默认值：真

引导类路径：

指定引导类所在的路径。bootclasspath 可以包含多个路径，方法是用冒号 ( :)或分号 ( ; )分隔它们。
请参阅引导类路径。
  • 类型：java.lang.String
  • 从: 2.5
  • 要求：否
  • 表达式：${bootclasspath}

引导类路径工件：

指定引导类所在的工件。
请参阅引导类路径。
例子： 
<bootclasspathArtifacts>
  <bootclasspathArtifact>
    <groupId>my-groupId</groupId>
    <artifactId>my-artifactId</artifactId>
    <version>my-version</version>
  </bootclasspathArtifact>
</bootclasspathArtifacts>

请参阅Javadoc。
  • 类型：org.apache.maven.plugin.javadoc.options.BootclasspathArtifact[]
  • 从: 2.5
  • 要求：否
  • 表达式：${bootclasspathArtifacts}

底部：

指定要放置在每个输出文件底部的文本。
如果你想使用 html 你必须把它放在一个 CDATA 部分，
例如。<![CDATA[版权所有 2005，<a href="http://www.mycompany.com">MyCompany, Inc.<a>]]>
见底部。
  • 类型：java.lang.String
  • 从: 2.6
  • 要求：否
  • 表达式：${底部}
  • 默认：版权 © {inceptionYear}-{currentYear} {organizationName}。版权所有。

破坏器：

使用断句迭代器来确定第一句的结尾。
请参阅breakiterator。
从Java 1.4 开始。
  • 类型：布尔值
  • 从: 2.6
  • 要求：否
  • 表达式：${breakiterator}
  • 默认值：假

字符集：

指定此文档的 HTML 字符集。如果未指定，则字符集值将是 docencoding参数的值。
请参阅字符集。
  • 类型：java.lang.String
  • 从: 2.6
  • 要求：否
  • 表达式：${charset}

调试：

将此设置为true以调试 Javadoc 插件。这样，在输出目录中提供了javadoc.bat(or.sh)、options、 @packages或argfile文件。
  • 类型：布尔值
  • 从: 2.1
  • 要求：否
  • 表达式：${debug}
  • 默认值：假

依赖源排除：

排除的依赖源模式列表。示例： org.apache.maven.shared:*
  • 类型：java.util.List
  • 从: 2.7
  • 要求：否

依赖源包括：

包含的依赖源模式列表。示例： org.apache.maven:*
  • 类型：java.util.List
  • 从: 2.7
  • 要求：否

目标目录：

指定 javadoc 保存生成的 HTML 文件的目标目录。见d。
  • 类型：java.io.File
  • 从: 2.6
  • 要求：否
  • 表达式：${destDir}

检测JavaApiLink：

检测当前构建的 Java API 链接，即 Java 源 1.4 的http://download.oracle.com/javase/1.4.2/docs/api/。
默认情况下，目标根据org.apache.maven.plugins:maven-compiler-plugin （在${project.build.plugins}或 ${project.build中 定义）中源参数 的值检测 Javadoc API 链接.pluginManagement}），或尝试从javadocExecutable版本计算它。 有关默认值，请参阅Javadoc 。

  • 类型：布尔值
  • 从: 2.6
  • 要求：否
  • 表达式：${detectJavaApiLink}
  • 默认值：真

检测链接：

检测项目中定义的所有依赖项的 Javadoc 链接。检测基于默认的 Maven 约定，即：${project.url}/apidocs。
例如，如果项目依赖于Apache Commons Lang ， 即： 
<dependency>
  <groupId>commons-lang</groupId>
  <artifactId>commons-lang</artifactId>
</dependency>
添加的 Javadoc -link参数将为 http://commons.apache.org/lang/apidocs。
  • 类型：布尔值
  • 从: 2.6
  • 要求：否
  • 表达式：${detectLinks}
  • 默认值：假

检测离线链接：

检测项目中定义的所有模块的链接。
如果reactorProjects以非聚合方式定义，它会根据定义的项目的 url 在模块之间生成默认的离线链接。例如，如果父项目有两个项目module1和module2，则 -linkoffline将为：为module1
添加的 Javadoc -linkoffline参数 将为 /absolute/path/to/ module2 /target/site/apidocs 添加的 Javadoc -linkoffline参数对于 module2将是 /absolute/path/to/ module1 /target/site/apidocs
  • 类型：布尔值
  • 从: 2.6
  • 要求：否
  • 表达式：${detectOfflineLinks}
  • 默认值：真

文档编码：

指定生成的 HTML 文件的编码。如果未指定，则文档编码值将为UTF-8。
请参阅文档编码。
  • 类型：java.lang.String
  • 从: 2.6
  • 要求：否
  • 表达式：${docencoding}
  • 默认值：${project.reporting.outputEncoding}

文档文件子目录：

启用从 javadocDirectory目录（例如 src/main/javadoc/com/mycompany/myapp/doc-files和 src/main/javadoc/resources）深度复制**/doc-files目录和特定资源目录。 请参阅docfilessubdirs。 从Java 1.4 开始。 请参阅javadocDirectory。



  • 类型：布尔值
  • 从: 2.6
  • 要求：否
  • 表达式：${docfilessubdirs}
  • 默认值：假

文档集：

指定启动用于生成文档的 doclet 的类文件。
请参阅doclet。
  • 类型：java.lang.String
  • 从: 2.6
  • 要求：否
  • 表达式：${doclet}

docletArtifact：

指定包含 doclet 起始类文件的工件（使用-doclet选项指定）。
请参阅docletpath。
例子： 
<docletArtifact>
  <groupId>com.sun.tools.doclets</groupId>
  <artifactId>doccheck</artifactId>
  <version>1.2b2</version>
</docletArtifact>

请参阅Javadoc。
  • 类型：org.apache.maven.plugin.javadoc.options.DocletArtifact
  • 从: 2.6
  • 要求：否
  • 表达式：${docletArtifact}

docletArtifacts：

指定包含 doclet 起始类文件的路径的多个工件（使用-doclet 选项指定）。
请参阅docletpath。
例子： 
<docletArtifacts>
  <docletArtifact>
    <groupId>com.sun.tools.doclets</groupId>
    <artifactId>doccheck</artifactId>
    <version>1.2b2</version>
  </docletArtifact>
</docletArtifacts>

请参阅Javadoc。
  • 类型：org.apache.maven.plugin.javadoc.options.DocletArtifact[]
  • 从: 2.1
  • 要求：否
  • 表达式：${docletArtifacts}

文档路径：

指定 doclet 起始类文件（使用-doclet选项指定）及其依赖的任何 jar 文件的路径。docletPath可以包含多个路径，方法是用冒号 ( : ) 或分号 ( ; )分隔它们。
请参阅docletpath。
  • 类型：java.lang.String
  • 从: 2.6
  • 要求：否
  • 表达式：${docletPath}

文件名：

指定要放置在概览摘要文件顶部附近的标题。
见文档标题。
  • 类型：java.lang.String
  • 从: 2.6
  • 要求：否
  • 表达式：${doctitle}
  • 默认值：${project.name} ${project.version} API

编码：

指定源文件的编码名称。如果未指定，则编码值将是 file.encoding系统属性的值。
请参阅编码。
注意：在 2.4 中，默认值被锁定为 ISO-8859-1以确保重现构建，但在 2.5 中恢复了这一点。
  • 类型：java.lang.String
  • 从: 2.6
  • 要求：否
  • 表达式：${编码}
  • 默认值：${project.build.sourceEncoding}

排除包名称：

从-subpackages形成的列表中无条件地排除指定的包及其子包。多个包可以用逗号 ( , )、冒号 (:)或分号 ( ; ) 分隔。
例子： 

<excludePackageNames>*.internal:org.acme.exclude1.*:org.acme.exclude2</excludePackageNames>

请参阅排除。
从Java 1.4 开始。
  • 类型：java.lang.String
  • 从: 2.6
  • 要求：否
  • 表达式：${excludePackageNames}

排除的ocfilessubdir：

排除任何具有给定名称的“doc-files”子目录。可以通过用冒号 ( : )分隔多个模式来排除它们。
请参阅excludeocfilessubdir。
从Java 1.4 开始。
  • 类型：java.lang.String
  • 从: 2.6
  • 要求：否
  • 表达式：${excludedocfilessubdir}

扩展目录：

指定扩展类所在的目录。使用冒号 ( :)或分号 ( ; )分隔extdirs中的目录。 请参阅extdirs。
  • 类型：java.lang.String
  • 从: 2.6
  • 要求：否
  • 表达式：${extdirs}

失败错误：

指定如果在 javadoc 执行期间出现错误，构建是否会失败。
  • 类型：布尔值
  • 从: 2.5
  • 要求：否
  • 表达式：${maven.javadoc.failOnError}
  • 默认值：真

最终名称：

指定将用于生成的 jar 文件的文件名。请注意-javadoc或 -test-javadoc将附加到文件名。
  • 类型：java.lang.String
  • 从: 2.6
  • 要求：否
  • 表达式：${project.build.finalName}

页脚：

指定要放置在每个输出文件底部的页脚文本。
见页脚。
  • 类型：java.lang.String
  • 从: 2.6
  • 要求：否
  • 表达式：${footer}

团体：

将概览页面上的包分成您指定的任何组，每个表一组。包模式可以是任何包名称，也可以是任何包名称的开头，后跟星号 ( * )，意思是“匹配任何字符”。多个模式可以包含在一个组中，方法是用冒号 (:) 分隔它们。
例子： 
<groups>
  <group>
    <title>Core Packages</title>
    <!-- To includes java.lang, java.lang.ref,
    java.lang.reflect and only java.util
    (i.e. not java.util.jar) -->
    <packages>java.lang*:java.util</packages>
  </group>
  <group>
    <title>Extension Packages</title>
     <!-- To include javax.accessibility,
    javax.crypto, ... (among others) -->
    <packages>javax.*</packages>
  </group>
</groups>
注意：对 包使用java.lang.*会省略java.lang包，但使用java.lang*会包含它。 见组。 请参阅Javadoc。


  • 类型：org.apache.maven.plugin.javadoc.options.Group[]
  • 从: 2.6
  • 要求：否
  • 表达式：${groups}

标题：

指定要放置在每个输出文件顶部的标题文本。
见标题。
  • 类型：java.lang.String
  • 从: 2.6
  • 要求：否
  • 表达式：${header}

帮助文件：

指定顶部和底部导航栏中的帮助链接链接到的备用帮助文件路径\文件名的路径。
注意：可能与 <nohelp/> 冲突。帮助文件可以是绝对文件路径
。 从 2.6 开始，它也可以是来自当前项目源目录中的资源（即 src/main/java、src/main/resources或 src/main/javadoc）或来自 Javadoc 插件依赖项中的资源的路径，例如实例： 

<helpfile>path/to/your/resource/yourhelp-doc.html</helpfile>
path/to/your/resource/ yourhelp -doc.html可能在src/main/javadoc中。 
<构建>
  <插件>
    <插件>
      <groupId>org.apache.maven.plugins</groupId>
      <artifactId>maven-javadoc-plugin</artifactId>
      <配置>
        

<helpfile>path/to/your/resource/yourhelp-doc.html</helpfile>
        ...
      </配置>
      <依赖项>
        <依赖>
          <groupId>groupId</groupId>
          <artifactId>artifactId</artifactId>
          <版本>版本</版本>
        </依赖>
      </依赖>
    </插件>
    ...
  <插件>
</build>
其中path/to/your/resource/yourhelp-doc.html在groupId:artifactId:version javadoc 插件依赖项中定义。
请参阅帮助文件。
  • 类型：java.lang.String
  • 从: 2.6
  • 要求：否
  • 表达式：${helpfile}

包括依赖来源：

是否应解析依赖源 jar 并将其包含为 javadoc 生成的源路径。这在为分发项目创建 javadocs 时很有用。
  • 类型：布尔值
  • 从: 2.7
  • 要求：否
  • 默认值：假

包括TransitiveDependencySources：

是否在要包含在此 javadoc 运行中的依赖源 jar 列表中包含传递依赖项。
  • 类型：布尔值
  • 从: 2.7
  • 要求：否
  • 默认值：假

罐子输出目录：

指定将放置生成的 jar 文件的目录。
  • 类型：java.lang.String
  • 从: 2.6
  • 要求：否
  • 表达式：${project.build.directory}

javaApiLinks：

仅当Sun Javadoc API url 已更改或为 Javadoc API url 使用自定义 url时才使用此参数。
有关默认值，请参阅Javadoc 。
  • 类型：java.util.Properties
  • 从: 2.6
  • 要求：否
  • 表达式：${javaApiLinks}

javadoc目录：

指定要包含在 Javadoc 中的 Javadoc 资源目录（即 package.html、images...）。
可以与docfilessubdirs 参数一起使用。
请参阅docfilessubdirs。
  • 类型：java.io.File
  • 从: 2.1
  • 要求：否
  • 表达式：${basedir}/src/main/javadoc

javadoc可执行文件：

设置要使用的 Javadoc Tool 可执行文件的绝对路径。从 2.5 版开始，仅仅一个目录规范就足以让插件分别使用该目录中的“javadoc”或“javadoc.exe”。
  • 类型：java.lang.String
  • 从: 2.3
  • 要求：否
  • 表达式：${javadocExecutable}

javadoc版本：

要使用的 Javadoc 工具可执行文件的版本，例如。“1.3”、“1.5”。
  • 类型：java.lang.String
  • 从: 2.3
  • 要求：否
  • 表达式：${javadocVersion}

关键词：

将 HTML 元关键字标签添加到每个类的生成文件中。
见关键字。
从Java 1.4.2 开始。
从Java 5.0 开始。
  • 类型：布尔值
  • 从: 2.1
  • 要求：否
  • 表达式：${keywords}
  • 默认值：假

链接：

创建指向现有 javadoc 生成的外部引用类文档的链接。
备注：
  1. 仅在isOffline设置为 false时使用。
  2. 所有给定的链接都应该有一个可 获取的/package-list文件。例如： 
    <links>
  <link>http://download.oracle.com/javase/1.4.2/docs/api</link>
<links>
    将被使用，因为 http://download.oracle.com/javase/1.4.2/docs/api/package-list 存在。
  3. 如果定义了detectLinks，则会自动添加项目依赖项之间的链接。
  4. 如果定义了detectJavaApiLink，将自动添加一个基于项目源的Java版本的Java API链接。
见链接。
  • 类型：java.util.ArrayList
  • 从: 2.6
  • 要求：否
  • 表达式：${links}

链接源：

创建每个源文件的 HTML 版本（带有行号）并从标准 HTML 文档添加指向它们的链接。
见链接源。
从Java 1.4 开始。
  • 类型：布尔值
  • 从: 2.6
  • 要求：否
  • 表达式：${linksource}
  • 默认值：假

本地存储库：

工件所在的本地存储库。
  • 类型：org.apache.maven.artifact.repository.ArtifactRepository
  • 从: 2.6
  • 要求：否
  • 表达式：${localRepository}

语言环境：

指定 javadoc 在生成文档时使用的语言环境。
请参阅语言环境。
  • 类型：java.lang.String
  • 从: 2.6
  • 要求：否
  • 表达式：${locale}

最大内存：

指定启动 Javadoc 工具时要使用的最大 Java 堆大小。JVM 将此属性称为-Xmx 参数。示例：“512”或“512m”。内存单元取决于使用的 JVM。支持的单位可以是：k、 kb、m、mb、g、 gb、t、tb。如果未指定单位，则默认单位为m。
  • 类型：java.lang.String
  • 从: 2.6
  • 要求：否
  • 表达式：${maxmemory}

最小内存：

指定启动 Javadoc 工具时要使用的最小 Java 堆大小。JVM 将此属性称为-Xms 参数。示例：“512”或“512m”。内存单元取决于使用的 JVM。支持的单位可以是：k、 kb、m、mb、g、 gb、t、tb。如果未指定单位，则默认单位为m。
  • 类型：java.lang.String
  • 从: 2.6
  • 要求：否
  • 表达式：${minmemory}

无评论：

抑制整个评论正文，包括主要描述和所有标签，只生成声明。
见无评论。
从Java 1.4 开始。
  • 类型：布尔值
  • 从: 2.6
  • 要求：否
  • 表达式：${nocomment}
  • 默认值：假

节点不推荐：

防止在文档中生成任何已弃用的 API。
请参阅nodeprecated。
  • 类型：布尔值
  • 从: 2.6
  • 要求：否
  • 表达式：${nodeprecated}
  • 默认值：假

节点推荐列表：

防止生成包含已弃用 API 列表 (deprecated-list.html) 和导航栏中指向该页面的链接的文件。
请参阅nodeprecatedlist。
  • 类型：布尔值
  • 从: 2.6
  • 要求：否
  • 表达式：${nodeprecatedlist}
  • 默认值：假

没有帮助：

省略每个输出页面顶部和底部导航栏中的帮助链接。
注意：可能与 <helpfile/> 冲突。
请参阅无帮助。
  • 类型：布尔值
  • 从: 2.6
  • 要求：否
  • 表达式：${nohelp}
  • 默认值：假

无索引：

从生成的文档中省略索引。
注意：可能与 <splitindex/> 冲突。
见noindex。
  • 类型：布尔值
  • 从: 2.6
  • 要求：否
  • 表达式：${noindex}
  • 默认值：假

非avbar：

从生成的文档中省略导航栏。
请参阅nonavbar。
  • 类型：布尔值
  • 从: 2.6
  • 要求：否
  • 表达式：${nonavbar}
  • 默认值：假

概述：

从生成的文档中省略整个概述页面。
注意：可能与 <overview/> 冲突。
标准 Doclet 无证选项。
  • 类型：布尔值
  • 从: 2.4
  • 要求：否
  • 表达式：${nooverview}
  • 默认值：假

无限定词：

在输出中的类名之前省略合格的包名。例子： 
<noqualifier>all</noqualifier>
or
<noqualifier>packagename1:packagename2</noqualifier>
请参阅noqualifier。
从Java 1.4 开始。
  • 类型：java.lang.String
  • 从: 2.6
  • 要求：否
  • 表达式：${noqualifier}

鼻子：

从生成的文档中省略与 since 标签关联的“Since”部分。
见诺辛。
  • 类型：布尔值
  • 从: 2.6
  • 要求：否
  • 表达式：${nosince}
  • 默认值：假

时间戳：

抑制时间戳，它隐藏在每个页面顶部附近生成的 HTML 中的 HTML 注释中。
见nottimestamp。
从Java 5.0 开始。
  • 类型：布尔值
  • 从: 2.1
  • 要求：否
  • 表达式：${notimestamp}
  • 默认值：假

注意：

从生成的文档中省略类/接口层次结构页面。
见注。
  • 类型：布尔值
  • 从: 2.6
  • 要求：否
  • 表达式：${notree}
  • 默认值：假

离线链接：

此选项是-link的变体；它们都为外部引用的类创建指向 javadoc 生成的文档的链接。
见链接离线。
例子： 
<offlineLinks>
  <offlineLink>
    <url>http://download.oracle.com/javase/1.5.0/docs/api/</url>
    <location>../javadoc/jdk-5.0/</location>
  </offlineLink>
</offlineLinks>

注意：如果定义了detectOfflineLinks，则如果目标以非聚合器方式调用，则会自动添加项目模块之间的离线链接。
请参阅Javadoc。
  • 类型：org.apache.maven.plugin.javadoc.options.OfflineLink[]
  • 从: 2.6
  • 要求：否
  • 表达式：${offlineLinks}

旧：

此选项使用 Javadoc 1.1 生成的文档的外观和功能创建文档。
见1.1。
  • 类型：布尔值
  • 从: 2.6
  • 要求：否
  • 表达式：${old}
  • 默认值：假

输出目录：

指定 Javadoc 保存生成的 HTML 文件的目标目录。
见d。
  • 类型：java.io.File
  • 从: 2.6
  • 要求：是
  • 默认值：${project.build.directory}/testapidocs

概述：

指定 javadoc 应从路径/文件名指定的“源”文件中检索概述文档的文本并将其放置在概述页面 (overview-summary.html) 上。
注意：可能与 <nooverview/> 冲突。
请参阅概述。
  • 类型：java.io.File
  • 从: 2.6
  • 要求：否
  • 表达式：${overview}
  • 默认值：${basedir}/src/main/javadoc/overview.html

包头：

指定左上框架的文本。
从Java 1.4.2 开始。
  • 类型：java.lang.String
  • 从: 2.1
  • 要求：否
  • 表达式：${packagesheader}

代理主机：

已弃用。从 2.4 开始。而不是在 settings.xml中配置活动代理主机。
指定-link中的 javadoc Web 访问 将通过的代理主机。默认为settings.xml中设置的活动代理的代理主机，否则获取 pom 中设置的代理配置。
  • 类型：java.lang.String
  • 从: 2.6
  • 要求：否
  • 表达式：${proxyHost}

代理端口：

已弃用。从 2.4 开始。而不是在 settings.xml中配置活动代理端口。
指定-link中的 javadoc Web 访问 将通过的代理端口。默认为settings.xml中设置的活动代理的代理端口，否则获取 pom 中设置的代理配置。
  • 类型：整数
  • 从: 2.6
  • 要求：否
  • 表达式：${proxyPort}

安静：

关闭非错误和非警告消息，只留下警告和错误出现，使其更易于查看。
注意：是 Java 1.4.2 中的标准 doclet（请参阅错误 ID 4714350）。
见静。
从 Java 5.0 开始。
  • 类型：布尔值
  • 从: 2.6
  • 要求：否
  • 表达式：${安静}
  • 默认值：假

远程存储库：

工件所在的远程存储库。
  • 类型：java.util.List
  • 从: 2.6
  • 要求：否
  • 表达式：${project.remoteArtifactRepositories}

资源工件：

包含应复制到 Javadoc 输出目录（如样式表、图标等）的资源的工件列表。
例子： 
<resourcesArtifacts>
  <resourcesArtifact>
    <groupId>external.group.id</groupId>
    <artifactId>external-resources</artifactId>
    <version>1.0</version>
  </resourcesArtifact>
</resourcesArtifacts>

请参阅Javadoc。
  • 类型：org.apache.maven.plugin.javadoc.options.ResourcesArtifact[]
  • 从: 2.5
  • 要求：否
  • 表达式：${resourcesArtifacts}

串行警告：

为缺少的串行标签生成编译时警告。
请参阅串行警告
  • 类型：布尔值
  • 从: 2.6
  • 要求：否
  • 表达式：${serialwarn}
  • 默认值：假

显示：

指定要在 Javadocs 中显示的类和成员的访问级别。可能的值为：
  • public （仅显示公共类和成员）
  • protected （仅显示公共和受保护的类和成员）
  • 包 （显示所有未标记为私有的类和成员）
  • 私有 （显示所有类和成员）

  • 类型：java.lang.String
  • 从: 2.6
  • 要求：否
  • 表达式：${show}
  • 默认值：受保护

跳过：

指定是否应跳过 Javadoc 生成。
  • 类型：布尔值
  • 从: 2.5
  • 要求：否
  • 表达式：${maven.javadoc.skip}
  • 默认值：假

来源：

需要使 javadoc 能够处理 J2SE v 1.4 源代码中引入的断言或 J2SE v5 中引入的泛型。
见源。
从Java 1.4 开始。
  • 类型：java.lang.String
  • 从: 2.6
  • 要求：否
  • 表达式：${source}

sourceDependencyCacheDir：

解压后的项目源/测试源应该被缓存的目录。
  • 类型：java.io.File
  • 从: 2.7
  • 要求：否
  • 默认值：${project.build.directory}/distro-javadoc-sources

源路径：

指定子包所在的源路径。源路径可以包含多个路径，方法是用冒号( :)或分号 ( ; )分隔它们。
请参阅源路径。
  • 类型：java.lang.String
  • 从: 2.6
  • 要求：否
  • 表达式：${sourcepath}

源标签：

指定每个选项卡在源中占用的空格数。如果源中没有使用制表符，则使用默认空间。
注意：是Java 1.4.2 中的linksourcetab（请参阅错误 ID 4788919）。
从1.4.2 开始。
从 Java 5.0 开始。
  • 类型：整数
  • 从: 2.1
  • 要求：否
  • 表达式：${sourcetab}

拆分索引：

将索引文件拆分为多个文件，按字母顺序，每个字母一个文件，再加上一个用于任何以非字母字符开头的索引条目的文件。
注意：可能与 <noindex/> 冲突。
请参阅拆分索引。
  • 类型：布尔值
  • 从: 2.6
  • 要求：否
  • 表达式：${splitindex}
  • 默认值：假

样式表：

当未指定stylesheetfile参数时，指定要使用的样式表是 maven的 javadoc 样式表还是java的默认样式表。 可能的值：maven或java。

  • 类型：java.lang.String
  • 从: 2.6
  • 要求：否
  • 表达式：${stylesheet}
  • 默认值：java

样式表文件：

指定备用 HTML 样式表文件的路径。样式表
文件可以是绝对文件路径。 从 2.6 开始，它也可以是来自当前项目源目录中的资源（即 src/main/java、src/main/resources或 src/main/javadoc）或来自 Javadoc 插件依赖项中的资源的路径，例如实例： 

<stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile>
path/to/your/resource/yourstylesheet.css 可能位于src/main/javadoc中。 
<构建>
  <插件>
    <插件>
      <groupId>org.apache.maven.plugins</groupId>
      <artifactId>maven-javadoc-plugin</artifactId>
      <配置>
        

<stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile>
        ...
      </配置>
      <依赖项>
        <依赖>
          <groupId>groupId</groupId>
          <artifactId>artifactId</artifactId>
          <版本>版本</版本>
        </依赖>
      </依赖>
    </插件>
    ...
  <插件>
</build>
其中path/to/your/resource/yourstylesheet.css在groupId:artifactId:version javadoc 插件依赖项中定义。
请参阅样式表文件。
  • 类型：java.lang.String
  • 从: 2.6
  • 要求：否
  • 表达式：${stylesheetfile}

子包：

指定将执行 javadoc 的包目录。多个包可以用冒号 ( : ) 分隔。
请参阅子包。
从Java 1.4 开始。
  • 类型：java.lang.String
  • 从: 2.6
  • 要求：否
  • 表达式：${subpackages}

小标签：

指定启动用于生成该标记的文档的标记的类文件。
见小标签。
从Java 1.4 开始。
  • 类型：java.lang.String
  • 从: 2.6
  • 要求：否
  • 表达式：${taglet}

tagletArtifact：

指定包含 taglet 类文件 (.class) 的 Taglet 工件。
请参阅标记路径。
例子： 
<taglets>
  <taglet>
    <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass>
  </taglet>
  <taglet>
    <tagletClass>package.to.AnotherTagletClass</tagletClass>
  </taglet>
  ...
</taglets>
<tagletArtifact>
  <groupId>group-Taglet</groupId>
  <artifactId>artifact-Taglet</artifactId>
  <version>version-Taglet</version>
</tagletArtifact>

请参阅Javadoc。
  • 类型：org.apache.maven.plugin.javadoc.options.TagletArtifact
  • 从: 2.1
  • 要求：否
  • 表达式：${tagletArtifact}

tagletArtifacts：

指定几个包含 taglet 类文件 (.class) 的 Taglet 工件。这些 taglets 类名将被自动检测，因此无需指定它们。
见小标签。
请参阅标记路径。
例子： 
<tagletArtifacts>
  <tagletArtifact>
    <groupId>group-Taglet</groupId>
    <artifactId>artifact-Taglet</artifactId>
    <version>version-Taglet</version>
  </tagletArtifact>
  ...
</tagletArtifacts>

请参阅Javadoc。
  • 类型：org.apache.maven.plugin.javadoc.options.TagletArtifact[]
  • 从: 2.5
  • 要求：否
  • 表达式：${tagletArtifacts}

标记路径：

指定用于查找 taglet 类文件 (.class) 的搜索路径。tagletpath可以包含多个路径，方法是用冒号 ( : ) 或分号 ( ; )分隔它们。
请参阅标记路径。
从Java 1.4 开始。
  • 类型：java.lang.String
  • 从: 2.6
  • 要求：否
  • 表达式：${tagletpath}

小标签：

使 Javadoc 工具能够解释多个 taglet。
见小标签。
请参阅标记路径。
例子： 
<taglets>
  <taglet>
    <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass>
    <!--<tagletpath>/home/taglets</tagletpath>-->
    <tagletArtifact>
      <groupId>group-Taglet</groupId>
      <artifactId>artifact-Taglet</artifactId>
      <version>version-Taglet</version>
    </tagletArtifact>
  </taglet>
</taglets>

请参阅Javadoc。
  • 类型：org.apache.maven.plugin.javadoc.options.Taglet[]
  • 从: 2.1
  • 要求：否
  • 表达式：${taglets}

标签：

使 Javadoc 工具能够解释文档注释中的简单、单参数自定义块标记标记名。
见标签。
从Java 1.4 开始。
例子： 
<tags>
  <tag>
    <name>todo</name>
    <placement>a</placement>
    <head>To Do:</head>
  </tag>
</tags>
注意：位置应该是 Xaoptcmf 字母的组合：
  • X（禁用标签）
  • 一个（全部）
  • o（概述）
  • p（包）
  • t（类型，即类和接口）
  • c（构造函数）
  • 米（方法）
  • f（字段）
请参阅Javadoc。
  • 类型：org.apache.maven.plugin.javadoc.options.Tag[]
  • 从: 2.6
  • 要求：否
  • 表达式：${tags}

测试文档标题：

指定要放置在概览摘要文件顶部附近的测试标题。
见文档标题。
  • 类型：java.lang.String
  • 从: 2.5
  • 要求：否
  • 表达式：${testDoctitle}
  • 默认值：${project.name} ${project.version} 测试 API

测试Javadoc目录：

指定要包含在 Javadoc 中的 Test Javadoc 资源目录（即 package.html、images...）。
  • 类型：java.io.File
  • 从: 2.5
  • 要求：否
  • 表达式：${basedir}/src/test/javadoc

测试概述：

指定 Javadoc 应从路径/文件名指定的“源”文件中检索测试概述文档的文本，并将其放置在概述页面 (overview-summary.html) 上。
请参阅概述。
  • 类型：java.io.File
  • 从: 2.5
  • 要求：否
  • 表达式：${testOverview}
  • 默认值：${basedir}/src/test/javadoc/overview.html

测试窗口标题：

指定要放置在 HTML 标题标签中的测试标题。
见窗口标题。
  • 类型：java.lang.String
  • 从: 2.5
  • 要求：否
  • 表达式：${testWindowtitle}
  • 默认值：${project.name} ${project.version} 测试 API

顶部：

指定要放置在每个输出文件顶部的顶部文本。
见6227616。
从 Java 6.0 开始
  • 类型：java.lang.String
  • 从: 2.4
  • 要求：否
  • 表达式：${top}

使用：

每个记录的类和包都包括一个“使用”页面。
见使用。
  • 类型：布尔值
  • 从: 2.6
  • 要求：否
  • 表达式：${use}
  • 默认值：真

使用默认清单文件：

将此设置为true以启用 defaultManifestFile。
  • 类型：布尔值
  • 从: 2.5
  • 要求：否
  • 默认值：假

使用标准文档选项：

指定将标准 Doclet 提供的选项用于自定义 doclet。
例子： 
<docletArtifacts>
  <docletArtifact>
    <groupId>com.sun.tools.doclets</groupId>
    <artifactId>doccheck</artifactId>
    <version>1.2b2</version>
  </docletArtifact>
</docletArtifacts>
<useStandardDocletOptions>真</useStandardDocletOptions>
  • 类型：布尔值
  • 从: 2.5
  • 要求：否
  • 表达式：${useStandardDocletOptions}
  • 默认值：真

验证链接：

控制包列表 资源的内容验证的标志。如果设置， 将验证包列表资源的内容。
  • 类型：布尔值
  • 从: 2.8
  • 要求：否
  • 表达式：${validateLinks}
  • 默认值：假

详细：

在 javadoc 运行时提供更详细的消息。
见详细。
  • 类型：布尔值
  • 从: 2.6
  • 要求：否
  • 表达式：${详细}
  • 默认值：假

版本：

在生成的文档中包含版本文本。
见版本。
  • 类型：布尔值
  • 从: 2.6
  • 要求：否
  • 表达式：${版本}
  • 默认值：真

窗口标题：

指定要放置在 HTML 标题标签中的标题。
见窗口标题。
  • 类型：java.lang.String
  • 从: 2.6
  • 要求：否
  • 表达式：${windowtitle}
  • 默认值：${project.name} ${project.version} API