javadoc:javadoc

注意：这个目标应该用作 Maven 报告。

全名：

org.apache.maven.plugins:maven-javadoc-plugin:3.3.2:javadoc

说明：

使用标准Javadoc Tool为NON 聚合器项目中的Java 代码生成文档。

属性：

  • 需要执行一个 Maven 项目。
  • 需要范围内工件的依赖解析：compile。
  • 自版本：2.0。
  • 在执行自身之前调用生命周期阶段 generate-sources的执行。

必需参数

姓名 类型 自从 描述
<输出目录> 文件 2.0 指定 javadoc 保存生成的 HTML 文件的目标目录。

默认值为：${project.build.directory}/apidocs。
用户属性是：destDir。
别名是：destDir。
<报告输出目录> 文件 2.0 指定 javadoc 保存生成的 HTML 文件的目标目录。
默认值为：${project.reporting.outputDirectory}/apidocs。
用户属性是：reportOutputDirectory。

可选参数

姓名 类型 自从 描述
<添加样式表> 细绳[] 3.3.0 指定相对于javadocDirectory示例 的附加 HTML 样式表文件的路径：
    <addStylesheets>
        <resources/addstylesheet.css</addStylesheet>
    </addStylesheets>

<附加依赖项> 列表 2.8.1 能够向 javadoc 类路径添加其他依赖项。例子： 
<additionalDependencies>
  <additionalDependency>
    <groupId>geronimo-spec</groupId>
    <artifactId>geronimo-spec-jta</artifactId>
    <version>1.0.1B-rc4</version>
  </additionalDependency>
</additionalDependencies>

<附加选项> 细绳 2.3 在命令行上设置一个附加的 Javadoc 选项（即 JVM 选项）。例子： 
<additionalJOption>-J-Xss128m</additionalJOption>
请参阅Jflag。
请参阅vmoptions。
请参阅网络属性。
用户属性是：additionalJOption。
<附加的选项> 细绳[] 2.9 通过 javadoc 的“-J”选项为执行 javadoc 命令设置额外的 JVM 选项。例子： 
    <additionalJOptions>
        <additionalJOption>-J-Xmx1g </additionalJOption>
    </additionalJOptions>

<附加选项> 细绳[] 3.0.0 在命令行上设置附加选项。所有输入都将按原样传递给@options文件。您必须注意引用和转义。对于自定义 doclet 很有用。
<applyJavadocSecurityFix> 布尔值 2.9.1 要对生成的 javadoc 应用安全修复，请参阅 http://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2013-1571
默认值为：true。
用户属性是：maven.javadoc.applyJavadocSecurityFix。
<作者> 布尔值 2.0 指定作者文本是否包含在生成的 Javadocs 中。
见作者。

默认值为：true。
用户属性是：作者。
<引导类路径> 细绳 2.5 指定引导类所在的路径。bootclasspath 可以包含多个路径，方法是用冒号 ( :)或分号 ( ; )分隔它们。
请参阅引导类路径。
用户属性是：bootclasspath。
<bootclasspathArtifacts> 引导类路径Artifact[] 2.5 指定引导类所在的工件。
请参阅引导类路径。
例子： 
<bootclasspathArtifacts>
  <bootclasspathArtifact>
    <groupId>my-groupId</groupId>
    <artifactId>my-artifactId</artifactId>
    <version>my-version</version>
  </bootclasspathArtifact>
</bootclasspathArtifacts>

请参阅Javadoc。

用户属性是：bootclasspathArtifacts。
<底部> 细绳 2.0 指定要放置在每个输出文件底部的文本。
如果你想使用 html，你必须把它放在 CDATA 部分，
例如<![CDATA[Copyright 2005, <a href="http://www.mycompany.com">MyCompany, Inc.<a>] ]>
注意：如果项目具有 project.build.outputTimestamp属性，则其年份将用作 {currentYear}。这样就可以生成可重现的 javadoc jar。
见底部。

默认值为：版权 © {inceptionYear}–{currentYear} {organizationName}。版权所有。.
用户属性为：bottom。
<breakiterator> 布尔值 2.0 使用断句迭代器来确定第一句的结尾。
请参阅breakiterator。
从Java 1.4 开始。

默认值为：false。
用户属性是：breakiterator。
<字符集> 细绳 2.0 指定此文档的 HTML 字符集。如果未指定，则字符集值将是 docencoding参数的值。
请参阅字符集。

用户属性是：字符集。
<调试> 布尔值 2.1 将此设置为true以调试 Javadoc 插件。这样，在输出目录中提供了javadoc.bat(or.sh)、options、 @packages或argfile文件。

默认值为：false。
用户属性是：调试。
<依赖链接> 列表 3.3.0 使用detectLinks时，重新定义特定依赖项的 apidoc URL 。如果依赖项不是使用 Maven 构建的，或者 apidocs 已被移动，则很有用。 
<dependencyLinks>
  <dependencyLink>
    <groupId>groupId</groupId>
    <artifactId>artifactId</artifactId>
    <classifier>classifier</classifier> <!-- optional --> 
    <url>version</url>
  </dependencyLink>
</dependencyLinks>

<dependencySourceExcludes> 列表 2.7 排除的依赖源模式列表。示例： org.apache.maven.shared:*
<dependencySourceIncludes> 列表 2.7 包含的依赖源模式列表。示例： org.apache.maven:*
<说明> 细绳 2.1 要在 Maven 生成的报告页面中显示的 Javadoc 报告的描述（即project-reports.html）。
用户属性是：描述。
<目标目录> 细绳 2.1 目标目录的名称。

默认值为：apidocs。
用户属性是：destDir。
<detectJavaApiLink> 布尔值 2.6 检测当前构建的 Java API 链接，即 Java 源 1.4 的https://docs.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。用户属性是：detectJavaApiLink。
<检测链接> 布尔值 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。
用户属性是：detectLinks。
<detectOfflineLinks> 布尔值 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。
用户属性是：detectOfflineLinks。
<文档编码> 细绳 2.0 指定生成的 HTML 文件的编码。如果未指定，则文档编码值将为UTF-8。
请参阅文档编码。
默认值为：${project.reporting.outputEncoding}。
用户属性是：docencoding。
<文档文件子目录> 布尔值 2.0 启用从 javadocDirectory目录（例如 src/main/javadoc/com/mycompany/myapp/doc-files和 src/main/javadoc/resources）深度复制**/doc-files目录和特定资源目录。 请参阅docfilessubdirs。 从Java 1.4 开始。 请参阅javadocDirectory。默认值为：false。用户属性是：docfilessubdirs。
<文档> 细绳 2.0 指定启动用于生成文档的 doclet 的类文件。
请参阅doclet。
用户属性是：doclet。
<docletArtifact> DocletArtifact 2.0 指定包含 doclet 起始类文件的工件（使用-doclet选项指定）。
请参阅docletpath。
例子： 
<docletArtifact>
  <groupId>com.sun.tools.doclets</groupId>
  <artifactId>doccheck</artifactId>
  <version>1.2b2</version>
</docletArtifact>

请参阅Javadoc。

用户属性是：docletArtifact。
<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。

用户属性是：docletArtifacts。
<doclet路径> 细绳 2.0 指定 doclet 起始类文件（使用-doclet选项指定）及其依赖的任何 jar 文件的路径。docletPath可以包含多个路径，方法是用冒号 ( : ) 或分号 ( ; )分隔它们。
请参阅docletpath。
用户属性是：docletPath。
<教义> 细绳 3.0.0 指定要对 Javadoc 注释执行的特定检查。
请参阅教义。
用户属性是：doclint。
<文档标题> 细绳 2.0 指定要放置在概览摘要文件顶部附近的标题。
见文档标题。

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

默认值为：${project.build.sourceEncoding}。
用户属性是：编码。
<排除包名称> 细绳 2.0 从-subpackages形成的列表中无条件地排除指定的包及其子包。多个包可以用逗号 ( , )、冒号 (:)或分号 ( ; ) 分隔。

通配符的工作方式如下：

  • 开头的通配符应匹配 1 个或多个文件夹
  • 任何其他通配符必须与一个文件夹完全匹配


例子：

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

请参阅排除。
从Java 1.4 开始。


用户属性是：excludePackageNames。
<排除文档文件子目录> 细绳 2.0 排除任何具有给定名称的“doc-files”子目录。可以通过用冒号 ( : )分隔多个模式来排除它们。
请参阅excludeocfilessubdir。
从Java 1.4 开始。
用户属性是：excludedocfilessubdir。
<扩展目录> 细绳 2.0 指定扩展类所在的目录。使用冒号 ( :)或分号 ( ; )分隔extdirs中的目录。 请参阅extdirs。用户属性是：extdirs。
<失败错误> 布尔值 2.5 指定如果在 javadoc 执行期间出现错误，构建是否会失败。
默认值为：true。
用户属性是：maven.javadoc.failOnError。
<失败警告> 布尔值 3.0.1 指定如果在 javadoc 执行期间出现警告，则构建是否会失败。
默认值为：false。
用户属性是：maven.javadoc.failOnWarnings。
<页脚> 细绳 2.0 指定要放置在每个输出文件底部的页脚文本。
见页脚。
用户属性是：页脚。
<组> 团体[] 2.0 将概览页面上的包分成您指定的任何组，每个表一组。包模式可以是任何包名称，也可以是任何包名称的开头，后跟星号 ( * )，意思是“匹配任何字符”。多个模式可以包含在一个组中，方法是用冒号 (:) 分隔它们。
例子： 
<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.0 指定要放置在每个输出文件顶部的标题文本。
见标题。
用户属性是：header。
<帮助文件> 细绳 2.0 指定顶部和底部导航栏中的帮助链接链接到的备用帮助文件路径\文件名的路径。
注意：可能与 <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 插件依赖项中定义。
请参阅帮助文件。
用户属性是：helpfile。
<includeDependencySources> 布尔值 2.7 是否应解析依赖源 jar 并将其包含为 javadoc 生成的源路径。这在为分发项目创建 javadocs 时很有用。
默认值为：false。
<includeTransitiveDependencySources> 布尔值 2.7 已弃用。如果这些源依赖于传递依赖项，则这些依赖项应作为直接依赖项添加到 pom
默认值为：false。
<javaApiLinks> 特性 2.6 仅当您要覆盖默认 URL时才使用此参数。密钥应与api_x匹配，其中 x与 Java 版本匹配。例如：
api_1.5
https://docs.oracle.com/javase/1.5.0/docs/api/
api_1.8
https://docs.oracle.com/javase/8/docs/api/
api_9
https://docs.oracle.com/javase/9​​/docs/api/

用户属性是：javaApiLinks。
<javadoc目录> 文件 2.1 指定要包含在 Javadoc 中的 Javadoc 资源目录（即 package.html、images...）。
可以与docfilessubdirs 参数一起使用。
请参阅docfilessubdirs。
默认值为：${basedir}/src/main/javadoc。
<javadoc 可执行文件> 细绳 2.3 设置要使用的 Javadoc Tool 可执行文件的绝对路径。从 2.5 版开始，仅仅一个目录规范就足以让插件分别使用该目录中的“javadoc”或“javadoc.exe”。
用户属性是：javadocExecutable。
<javadoc版本> 细绳 2.3 要使用的 Javadoc 工具可执行文件的版本，例如。“1.3”、“1.5”。
用户属性是：javadocVersion。
<jdk工具链> 地图 3.0.0

允许通过 maven 工具链配置 javadoc 工具。这会否决 maven-toolchain-plugin 选择的工具链。

例子：

（有关更多信息， 请参阅工具链指南）

<configuration>
       ...
       <jdkToolchain>
           <version>11</version>
       </jdkToolchain>
   </configuration>

   <configuration>
       ...
       <jdkToolchain>
           <version>1.8</version>
           <vendor>zulu</vendor>
       </jdkToolchain>
   </configuration>
注意：至少需要 Maven 3.3.1
<关键字> 布尔值 2.1 将 HTML 元关键字标签添加到每个类的生成文件中。
见关键字。
从Java 1.4.2 开始。
从Java 5.0 开始。

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

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

默认值为：false。
用户属性是：nocomment。
<节点不推荐> 布尔值 2.0 防止在文档中生成任何已弃用的 API。
请参阅nodeprecated。

默认值为：false。
用户属性是：nodeprecated。
<nodeprecatedlist> 布尔值 2.0 防止生成包含已弃用 API 列表 (deprecated-list.html) 和导航栏中指向该页面的链接的文件。
请参阅nodeprecatedlist。

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

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

默认值为：false。
用户属性是：noindex。
<nonavbar> 布尔值 2.0 从生成的文档中省略导航栏。
请参阅nonavbar。

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

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

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

默认值为：false。
用户属性是：nottimestamp。
<诺特里> 布尔值 2.0 从生成的文档中省略类/接口层次结构页面。

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

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

用户属性是：offlineLinks。
<旧> 布尔值 2.0 此选项使用 Javadoc 1.1 生成的文档的外观和功能创建文档。
见1.1。

默认值为：false。
用户属性是：旧的。
<输出时间戳> 细绳 3.2.0 可重现输出存档条目的时间戳，格式为 ISO 8601 yyyy-MM-dd'T'HH:mm:ssXXX或表示自纪元以来秒数的 int（如SOURCE_DATE_EPOCH）。
默认值为：${project.build.outputTimestamp}。
<概览> 文件 2.0 指定 javadoc 应从路径/文件名指定的“源”文件中检索概述文档的文本并将其放置在概述页面 (overview-summary.html) 上。
注意：可能与 <nooverview/> 冲突。
请参阅概述。

默认值为：${basedir}/src/main/javadoc/overview.html。
用户属性是：overview。
<包头> 细绳 2.1 指定左上框架的文本。
从Java 1.4.2 开始。
用户属性是：packagesheader。
<安静> 布尔值 2.0 关闭非错误和非警告消息，只留下警告和错误出现，使其更易于查看。
注意：是 Java 1.4.2 中的标准 doclet（请参阅错误 ID 4714350）。
见静。
从 Java 5.0 开始。

默认值为：false。
用户属性是：安静。
<发布> 细绳 JDK 9 提供与指定版本的源兼容性
默认值为：${maven.compiler.release}。
<resourcesArtifacts> 资源神器[] 2.5 包含应复制到 Javadoc 输出目录（如样式表、图标等）的资源的工件列表。
例子： 
<resourcesArtifacts>
  <resourcesArtifact>
    <groupId>external.group.id</groupId>
    <artifactId>external-resources</artifactId>
    <version>1.0</version>
  </resourcesArtifact>
</resourcesArtifacts>

请参阅Javadoc。

用户属性是：resourcesArtifacts。
<串行警告> 布尔值 2.0 为缺少的串行标签生成编译时警告。

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


默认值为：受保护。
用户属性是：show。
<跳过> 布尔值 2.5 指定是否应跳过 Javadoc 生成。
默认值为：false。
用户属性是：maven.javadoc.skip。
<跳过模块> 细绳 3.2.0

逗号分隔的模块列表 (artifactId) 不添加到聚合的 javadoc


用户属性是：maven.javadoc.skippedModules。
<来源> 细绳 2.0 使 javadoc 能够处理 J2SE v 1.4 源代码中引入的断言或 J2SE v5 中引入的泛型所必需的。
见源。
从Java 1.4 开始。
默认值为：${maven.compiler.source}。
用户属性是：源。
<sourceDependencyCacheDir> 文件 2.7 解压后的项目源/测试源应该被缓存的目录。
默认值为：${project.build.directory}/distro-javadoc-sources。
<sourceFileExcludes> 列表 2.9 排除源文件上的过滤器。如果您指定子包或子包排除，这些将被忽略。
<sourceFileIncludes> 列表 2.9 在源文件中包含过滤器。默认为 **\/\*.java。如果您指定子包或子包排除，这些将被忽略。
<源路径> 细绳 2.0 指定子包所在的源路径。源路径可以包含多个路径，方法是用冒号( :)或分号 ( ; )分隔它们。
请参阅源路径。
用户属性是：sourcepath。
<源标签> 整数 2.1 指定每个选项卡在源中占用的空格数。如果源中没有使用制表符，则使用默认空间。
注意：是Java 1.4.2 中的linksourcetab（请参阅错误 ID 4788919）。
从1.4.2 开始。
从 Java 5.0 开始。
用户属性是：sourcetab。
别名是：linksourcetab。
<拆分索引> 布尔值 2.0 将索引文件拆分为多个文件，按字母顺序，每个字母一个文件，加上一个文件，用于任何以非字母字符开头的索引条目。
注意：可能与 <noindex/> 冲突。
请参阅拆分索引。

默认值为：false。
用户属性是：splitindex。
<staleDataPath> 文件 3.2.0

用于存储先前 javadoc 运行状态的文件的位置。如果没有任何变化，这用于跳过生成。


默认值为：${project.build.directory}/maven-javadoc-plugin-stale-data.txt。
用户属性是：staleDataPath。
<样式表> 细绳 2.0 当未指定stylesheetfile参数时，指定要使用的样式表是 maven的 javadoc 样式表还是java的默认样式表。 可能的值：maven或java。默认值为：java。用户属性是：样式表。
<样式表文件> 细绳 2.0 指定备用 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.0 指定将执行 javadoc 的包目录。多个包可以用冒号 ( : ) 分隔。
请参阅子包。
从Java 1.4 开始。
用户属性是：子包。
<标签> 细绳 2.0 指定启动用于为该标签生成文档的 taglet 的类文件。
见小标签。
从Java 1.4 开始。
用户属性是：taglet。
<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。

用户属性是：tagletArtifact。
<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。

用户属性是：tagletArtifacts。
<标记路径> 细绳 2.0 指定用于查找 taglet 类文件 (.class) 的搜索路径。tagletpath可以包含多个路径，方法是用冒号 ( : ) 或分号 ( ; )分隔它们。
请参阅标记路径。
从Java 1.4 开始。
用户属性是：tagletpath。
<标签> 标签[] 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。

用户属性是：taglets。
<标签> 标签[] 2.0 使 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.4 指定要放置在每个输出文件顶部的顶部文本。
见6227616。
由于 Java 6.0
User 属性是：top。
<使用> 布尔值 2.0 每个记录的类和包都包括一个“使用”页面。
见使用。

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

默认值为：true。
用户属性是：useStandardDocletOptions。
<验证链接> 布尔值 2.8 控制包列表 资源的内容验证的标志。如果设置， 将验证包列表资源的内容。
默认值为：false。
用户属性是：validateLinks。
<详细> 布尔值 2.0 在 javadoc 运行时提供更详细的消息。
见详细。

默认值为：false。
用户属性是：详细。
<版本> 布尔值 2.0 在生成的文档中包含版本文本。
见版本。

默认值为：true。
用户属性是：版本。
<窗口标题> 细绳 2.0 指定要放置在 HTML 标题标签中的标题。
见窗口标题。

默认值为：${project.name} ${project.version} API。
用户属性是：windowtitle。

参数详情

<添加样式表>

指定相对于javadocDirectory示例 的附加 HTML 样式表文件的路径：
    <addStylesheets>
        <resources/addstylesheet.css</addStylesheet>
    </addStylesheets>
  • 类型：java.lang.String[]
  • 自：3.3.0
  • 要求：否

<附加依赖项>

能够向 javadoc 类路径添加其他依赖项。例子： 
<additionalDependencies>
  <additionalDependency>
    <groupId>geronimo-spec</groupId>
    <artifactId>geronimo-spec-jta</artifactId>
    <version>1.0.1B-rc4</version>
  </additionalDependency>
</additionalDependencies>
  • 类型：java.util.List
  • 从: 2.8.1
  • 要求：否

<附加选项>

在命令行上设置一个附加的 Javadoc 选项（即 JVM 选项）。例子： 
<additionalJOption>-J-Xss128m</additionalJOption>
请参阅Jflag。
请参阅vmoptions。
请参阅网络属性。
  • 类型：java.lang.String
  • 从: 2.3
  • 要求：否
  • 用户属性：additionalJOption

<附加的选项>

通过 javadoc 的“-J”选项为执行 javadoc 命令设置额外的 JVM 选项。例子： 
    <additionalJOptions>
        <additionalJOption>-J-Xmx1g </additionalJOption>
    </additionalJOptions>
  • 类型：java.lang.String[]
  • 从: 2.9
  • 要求：否

<附加选项>

在命令行上设置附加选项。所有输入都将按原样传递给@options文件。您必须注意引用和转义。对于自定义 doclet 很有用。
  • 类型：java.lang.String[]
  • 自：3.0.0
  • 要求：否

<applyJavadocSecurityFix>

要对生成的 javadoc 应用安全修复，请参阅 http://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2013-1571
  • 类型：布尔值
  • 自：2.9.1
  • 要求：否
  • 用户属性：maven.javadoc.applyJavadocSecurityFix
  • 默认值：真

<作者>

指定作者文本是否包含在生成的 Javadocs 中。
见作者。
  • 类型：布尔值
  • 从: 2.0
  • 要求：否
  • 用户属性：作者
  • 默认值：真

<引导类路径>

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

<bootclasspathArtifacts>

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

请参阅Javadoc。
  • 类型：org.apache.maven.plugins.javadoc.options.BootclasspathArtifact[]
  • 从: 2.5
  • 要求：否
  • 用户属性：bootclasspathArtifacts

<底部>

指定要放置在每个输出文件底部的文本。
如果你想使用 html，你必须把它放在 CDATA 部分，
例如<![CDATA[Copyright 2005, <a href="http://www.mycompany.com">MyCompany, Inc.<a>] ]>
注意：如果项目具有 project.build.outputTimestamp属性，则其年份将用作 {currentYear}。这样就可以生成可重现的 javadoc jar。
见底部。
  • 类型：java.lang.String
  • 从: 2.0
  • 要求：否
  • 用户属性：底部
  • 默认：版权 © {inceptionYear}–{currentYear} {organizationName}。版权所有。

<breakiterator>

使用断句迭代器来确定第一句的结尾。
请参阅breakiterator。
从Java 1.4 开始。
  • 类型：布尔值
  • 从: 2.0
  • 要求：否
  • 用户属性：breakiterator
  • 默认值：假

<字符集>

指定此文档的 HTML 字符集。如果未指定，则字符集值将是 docencoding参数的值。
请参阅字符集。
  • 类型：java.lang.String
  • 从: 2.0
  • 要求：否
  • 用户属性：字符集

<调试>

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

<依赖链接>

使用detectLinks时，重新定义特定依赖项的 apidoc URL 。如果依赖项不是使用 Maven 构建的，或者 apidocs 已被移动，则很有用。 
<dependencyLinks>
  <dependencyLink>
    <groupId>groupId</groupId>
    <artifactId>artifactId</artifactId>
    <classifier>classifier</classifier> <!-- optional --> 
    <url>version</url>
  </dependencyLink>
</dependencyLinks>
  • 类型：java.util.List
  • 自：3.3.0
  • 要求：否

<dependencySourceExcludes>

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

<dependencySourceIncludes>

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

<说明>

要在 Maven 生成的报告页面中显示的 Javadoc 报告的描述（即project-reports.html）。
  • 类型：java.lang.String
  • 从: 2.1
  • 要求：否
  • 用户属性：描述

<目标目录>

目标目录的名称。
  • 类型：java.lang.String
  • 从: 2.1
  • 要求：否
  • 用户属性：destDir
  • 默认值：apidocs

<detectJavaApiLink>

检测当前构建的 Java API 链接，即 Java 源 1.4 的https://docs.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
  • 默认值：假

<detectOfflineLinks>

检测项目中定义的所有模块的链接。
如果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.0
  • 要求：否
  • 用户属性：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.0
  • 要求：否
  • 用户属性：docfilessubdirs
  • 默认值：假

<文档>

指定启动用于生成文档的 doclet 的类文件。
请参阅doclet。
  • 类型：java.lang.String
  • 从: 2.0
  • 要求：否
  • 用户属性：doclet

<docletArtifact>

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

请参阅Javadoc。
  • 类型：org.apache.maven.plugins.javadoc.options.DocletArtifact
  • 从: 2.0
  • 要求：否
  • 用户属性：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.plugins.javadoc.options.DocletArtifact[]
  • 从: 2.1
  • 要求：否
  • 用户属性：docletArtifacts

<doclet路径>

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

<教义>

指定要对 Javadoc 注释执行的特定检查。
请参阅教义。
  • 类型：java.lang.String
  • 自：3.0.0
  • 要求：否
  • 用户属性：doclint

<文档标题>

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

<编码>

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

<排除包名称>

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

通配符的工作方式如下：

  • 开头的通配符应匹配 1 个或多个文件夹
  • 任何其他通配符必须与一个文件夹完全匹配


例子：

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

请参阅排除。
从Java 1.4 开始。

  • 类型：java.lang.String
  • 从: 2.0
  • 要求：否
  • 用户属性：excludePackageNames

<排除文档文件子目录>

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

<扩展目录>

指定扩展类所在的目录。使用冒号 ( :)或分号 ( ; )分隔extdirs中的目录。 请参阅extdirs。
  • 类型：java.lang.String
  • 从: 2.0
  • 要求：否
  • 用户属性：extdirs

<失败错误>

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

<失败警告>

指定如果在 javadoc 执行期间出现警告，则构建是否会失败。
  • 类型：布尔值
  • 自：3.0.1
  • 要求：否
  • 用户属性：maven.javadoc.failOnWarnings
  • 默认值：假

<页脚>

指定要放置在每个输出文件底部的页脚文本。
见页脚。
  • 类型：java.lang.String
  • 从: 2.0
  • 要求：否
  • 用户属性：页脚

<组>

将概览页面上的包分成您指定的任何组，每个表一组。包模式可以是任何包名称，也可以是任何包名称的开头，后跟星号 ( * )，意思是“匹配任何字符”。多个模式可以包含在一个组中，方法是用冒号 (:) 分隔它们。
例子： 
<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.plugins.javadoc.options.Group[]
  • 从: 2.0
  • 要求：否

<标题>

指定要放置在每个输出文件顶部的标题文本。
见标题。
  • 类型：java.lang.String
  • 从: 2.0
  • 要求：否
  • 用户属性：标题

<帮助文件>

指定顶部和底部导航栏中的帮助链接链接到的备用帮助文件路径\文件名的路径。
注意：可能与 <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.0
  • 要求：否
  • 用户属性：帮助文件

<includeDependencySources>

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

<includeTransitiveDependencySources>

已弃用。如果这些源依赖于传递依赖，那么这些依赖应该作为直接依赖添加到 pom
是否在要包含在此 javadoc 运行中的依赖源 jar 列表中包含传递依赖项。
  • 类型：布尔值
  • 从: 2.7
  • 要求：否
  • 默认值：假

<javaApiLinks>

仅当您要覆盖默认 URL时才使用此参数。密钥应与api_x匹配，其中 x与 Java 版本匹配。例如：
api_1.5
https://docs.oracle.com/javase/1.5.0/docs/api/
api_1.8
https://docs.oracle.com/javase/8/docs/api/
api_9
https://docs.oracle.com/javase/9​​/docs/api/
  • 类型：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

<jdk工具链>

允许通过 maven 工具链配置 javadoc 工具。这会否决 maven-toolchain-plugin 选择的工具链。

例子：

（有关更多信息， 请参阅工具链指南）

<configuration>
       ...
       <jdkToolchain>
           <version>11</version>
       </jdkToolchain>
   </configuration>

   <configuration>
       ...
       <jdkToolchain>
           <version>1.8</version>
           <vendor>zulu</vendor>
       </jdkToolchain>
   </configuration>
注意：至少需要 Maven 3.3.1
  • 类型：java.util.Map
  • 自：3.0.0
  • 要求：否

<关键字>

将 HTML 元关键字标签添加到每个类的生成文件中。
见关键字。
从Java 1.4.2 开始。
从Java 5.0 开始。
  • 类型：布尔值
  • 从: 2.1
  • 要求：否
  • 用户属性：关键字
  • 默认值：假

<链接>

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

<链接来源>

创建每个源文件的 HTML 版本（带有行号）并从标准 HTML 文档添加指向它们的链接。
见链接源。
从Java 1.4 开始。
  • 类型：布尔值
  • 从: 2.0
  • 要求：否
  • 用户属性：链接源
  • 默认值：假

<本地存储库>

工件所在的本地存储库。
  • 类型：org.apache.maven.artifact.repository.ArtifactRepository
  • 从: 2.0
  • 要求：否
  • 用户属性：localRepository

<语言环境>

指定 javadoc 在生成文档时使用的语言环境。
请参阅语言环境。
  • 类型：java.lang.String
  • 从: 2.0
  • 要求：否
  • 用户属性：语言环境

<最大内存>

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

<最小内存>

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

<名称>

要在 Maven 生成的报告页面中显示的 Javadoc 报告的名称（即project-reports.html）。
  • 类型：java.lang.String
  • 从: 2.1
  • 要求：否
  • 用户属性：名称

<无评论>

抑制整个评论正文，包括主要描述和所有标签，只生成声明。
见无评论。
从Java 1.4 开始。
  • 类型：布尔值
  • 从: 2.0
  • 要求：否
  • 用户属性：nocomment
  • 默认值：假

<节点不推荐>

防止在文档中生成任何已弃用的 API。
请参阅nodeprecated。
  • 类型：布尔值
  • 从: 2.0
  • 要求：否
  • 用户属性：nodeprecated
  • 默认值：假

<nodeprecatedlist>

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

<无帮助>

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

<无索引>

从生成的文档中省略索引。
注意：可能与 <splitindex/> 冲突。
见noindex。
  • 类型：布尔值
  • 从: 2.0
  • 要求：否
  • 用户属性：noindex
  • 默认值：假

<nonavbar>

从生成的文档中省略导航栏。
请参阅nonavbar。
  • 类型：布尔值
  • 从: 2.0
  • 要求：否
  • 用户属性：nonavbar
  • 默认值：假

<nooverview>

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

<无限定符>

在输出中的类名之前省略合格的包名。例子： 
<noqualifier>all</noqualifier>
or
<noqualifier>packagename1:packagename2</noqualifier>
请参阅noqualifier。
从Java 1.4 开始。
  • 类型：java.lang.String
  • 从: 2.0
  • 要求：否
  • 用户属性：noqualifier

<开始>

从生成的文档中省略与 since 标签关联的“Since”部分。
见诺辛。
  • 类型：布尔值
  • 从: 2.0
  • 要求：否
  • 用户属性：nosince
  • 默认值：假

<notimestamp>

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

<诺特里>

从生成的文档中省略类/接口层次结构页面。
  • 类型：布尔值
  • 从: 2.0
  • 要求：否
  • 用户属性：notree
  • 默认值：假

<离线链接>

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

注意：如果定义了detectOfflineLinks，如果目标以非聚合方式调用，项目模块之间的离线链接会自动添加。
  • 类型：org.apache.maven.plugins.javadoc.options.OfflineLink[]
  • 从: 2.0
  • 要求：否
  • 用户属性：offlineLinks

<旧>

此选项使用 Javadoc 1.1 生成的文档的外观和功能创建文档。
见1.1。
  • 类型：布尔值
  • 从: 2.0
  • 要求：否
  • 用户属性：旧
  • 默认值：假

<输出目录>

指定 javadoc 保存生成的 HTML 文件的目标目录。
  • 类型：java.io.File
  • 从: 2.0
  • 要求：是
  • 用户属性：destDir
  • 默认值：${project.build.directory}/apidocs
  • 别名：destDir

<输出时间戳>

可重现输出存档条目的时间戳，格式为 ISO 8601 yyyy-MM-dd'T'HH:mm:ssXXX或表示自纪元以来秒数的 int（如SOURCE_DATE_EPOCH）。
  • 类型：java.lang.String
  • 自：3.2.0
  • 要求：否
  • 默认值：${project.build.outputTimestamp}

<概览>

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

<包头>

指定左上框架的文本。
从Java 1.4.2 开始。
  • 类型：java.lang.String
  • 从: 2.1
  • 要求：否
  • 用户属性：packagesheader

<安静>

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

<发布>

提供与指定版本的源兼容性
  • 类型：java.lang.String
  • 自：JDK 9
  • 要求：否
  • 默认值：${maven.compiler.release}

<报告输出目录>

指定 javadoc 保存生成的 HTML 文件的目标目录。
  • 类型：java.io.File
  • 从: 2.0
  • 要求：是
  • 用户属性：reportOutputDirectory
  • 默认值：${project.reporting.outputDirectory}/apidocs

<resourcesArtifacts>

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

请参阅Javadoc。
  • 类型：org.apache.maven.plugins.javadoc.options.ResourcesArtifact[]
  • 从: 2.5
  • 要求：否
  • 用户属性：resourcesArtifacts

<串行警告>

为缺少的串行标签生成编译时警告。
  • 类型：布尔值
  • 从: 2.0
  • 要求：否
  • 用户属性：serialwarn
  • 默认值：假

<显示>

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

  • 类型：java.lang.String
  • 从: 2.0
  • 要求：否
  • 用户属性：显示
  • 默认值：受保护

<跳过>

指定是否应跳过 Javadoc 生成。
  • 类型：布尔值
  • 从: 2.5
  • 要求：否
  • 用户属性：maven.javadoc.skip
  • 默认值：假

<跳过模块>

逗号分隔的模块列表 (artifactId) 不添加到聚合的 javadoc

  • 类型：java.lang.String
  • 自：3.2.0
  • 要求：否
  • 用户属性：maven.javadoc.skippedModules

<来源>

使 javadoc 能够处理 J2SE v 1.4 源代码中引入的断言或 J2SE v5 中引入的泛型所必需的。
见源。
从Java 1.4 开始。
  • 类型：java.lang.String
  • 从: 2.0
  • 要求：否
  • 用户属性：来源
  • 默认值：${maven.compiler.source}

<sourceDependencyCacheDir>

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

<sourceFileExcludes>

排除源文件上的过滤器。如果您指定子包或子包排除，这些将被忽略。
  • 类型：java.util.List
  • 从: 2.9
  • 要求：否

<sourceFileIncludes>

在源文件中包含过滤器。默认为 **\/\*.java。如果您指定子包或子包排除，这些将被忽略。
  • 类型：java.util.List
  • 从: 2.9
  • 要求：否

<源路径>

指定子包所在的源路径。源路径可以包含多个路径，方法是用冒号( :)或分号 ( ; )分隔它们。
请参阅源路径。
  • 类型：java.lang.String
  • 从: 2.0
  • 要求：否
  • 用户属性：源路径

<源标签>

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

<拆分索引>

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

<staleDataPath>

用于存储先前 javadoc 运行状态的文件的位置。如果没有任何变化，这用于跳过生成。

  • 类型：java.io.File
  • 自：3.2.0
  • 要求：否
  • 用户属性：staleDataPath
  • 默认值：${project.build.directory}/maven-javadoc-plugin-stale-data.txt

<样式表>

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

  • 类型：java.lang.String
  • 从: 2.0
  • 要求：否
  • 用户属性：样式表
  • 默认值：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.0
  • 要求：否
  • 用户属性：样式表文件

<子包>

指定将执行 javadoc 的包目录。多个包可以用冒号 ( : ) 分隔。
请参阅子包。
从Java 1.4 开始。
  • 类型：java.lang.String
  • 从: 2.0
  • 要求：否
  • 用户属性：子包

<标签>

指定启动用于为该标签生成文档的 taglet 的类文件。
见小标签。
从Java 1.4 开始。
  • 类型：java.lang.String
  • 从: 2.0
  • 要求：否
  • 用户属性：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.plugins.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.plugins.javadoc.options.TagletArtifact[]
  • 从: 2.5
  • 要求：否
  • 用户属性：tagletArtifacts

<标记路径>

指定用于查找 taglet 类文件 (.class) 的搜索路径。tagletpath可以包含多个路径，方法是用冒号 ( : ) 或分号 ( ; )分隔它们。
请参阅标记路径。
从Java 1.4 开始。
  • 类型：java.lang.String
  • 从: 2.0
  • 要求：否
  • 用户属性：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.plugins.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.plugins.javadoc.options.Tag[]
  • 从: 2.0
  • 要求：否
  • 用户属性：标签

<顶部>

指定要放置在每个输出文件顶部的顶部文本。
见6227616。
从 Java 6.0 开始
  • 类型：java.lang.String
  • 从: 2.4
  • 要求：否
  • 用户属性：顶部

<使用>

每个记录的类和包都包括一个“使用”页面。
见使用。
  • 类型：布尔值
  • 从: 2.0
  • 要求：否
  • 用户属性：使用
  • 默认值：真

<useStandardDocletOptions>

指定将标准 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.0
  • 要求：否
  • 用户属性：详细
  • 默认值：假

<版本>

在生成的文档中包含版本文本。
见版本。
  • 类型：布尔值
  • 从: 2.0
  • 要求：否
  • 用户属性：版本
  • 默认值：真

<窗口标题>

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