jxr:测试聚合
注意:这个目标应该用作 Maven 报告。
全名:
org.apache.maven.plugins:maven-jxr-plugin:3.2.0:test-aggregate
说明:
为聚合项目中的测试代码生成组合 JXR 报告。
属性:
- 需要执行一个 Maven 项目。
- 作为聚合器插件执行。
- 该目标未标记为线程安全,因此不支持并行构建。
- 自版本:
2.3
. - 在执行自身之前调用生命周期阶段的执行。
test-compile
必需参数
姓名 | 类型 | 自从 | 描述 |
---|---|---|---|
<outputDirectory> |
File |
2.3 |
将生成报告主页的输出文件夹。请注意,仅当目标直接从命令行或默认生命周期运行时,此参数才相关。如果目标作为站点生成的一部分间接运行,则将使用在 Maven 站点插件中配置的输出目录。 默认值为: ${project.reporting.outputDirectory} 。 |
可选参数
姓名 | 类型 | 自从 | 描述 |
---|---|---|---|
<bottom> |
String |
2.3 |
外部参照 HTML 文件底部使用的字符串。 默认值为: Copyright © {inceptionYear}–{currentYear} {organizationName}. All rights reserved. 。用户属性是: bottom 。 |
<destDir> |
String |
2.3 |
外部参照文件将被复制到的文件夹。 默认值为: ${project.reporting.outputDirectory}/xref-test 。 |
<docTitle> |
String |
2.3 |
外部参照 HTML 文件的主页标题。 默认值为: ${project.name} ${project.version} Reference 。 |
<excludes> |
ArrayList |
2.1 |
要使用的排除模式列表。默认情况下不排除任何文件。 |
<includes> |
ArrayList |
2.1 |
要使用的包含模式列表。默认情况下,所有 .java 文件都包括在内。 |
<inputEncoding> |
String |
2.3 |
文件输入编码。 默认值为: ${project.build.sourceEncoding} 。用户属性是: encoding 。 |
<javadocVersion> |
String |
2.3 |
要使用的 Javadoc 模板的版本。该值应反映“java.specification.version”、“1.4”、“1.8”、“9”、“10”,默认情况下使用此系统属性。 用户属性是: javadocVersion 。 |
<linkJavadoc> |
boolean |
2.3 |
从源外部参照链接 Javadoc。默认为 true,如果正在使用 javadoc 插件,将自动链接。 默认值为: true 。 |
<outputEncoding> |
String |
2.3 |
文件输出编码。 默认值为: ${project.reporting.outputEncoding} 。用户属性是: outputEncoding 。 |
<skip> |
boolean |
2.3 |
是否跳过此执行。 默认值为: false 。用户属性是: maven.jxr.skip 。 |
<stylesheet> |
String |
2.3 |
用于外部参照 HTML 文件的样式表。不应该使用。如果使用,应该是绝对路径,例如
"${basedir}/myStyles.css" . |
<templateDir> |
String |
2.3 |
可以找到 Velocity 模板以生成概览、框架和摘要的目录。不应该使用。如果使用,应该是绝对路径,例如
"${basedir}/myTemplates" . |
<testJavadocDir> |
File |
2.3 |
为此项目生成测试 Javadoc 的文件夹。 默认值为: ${project.reporting.outputDirectory}/testapidocs 。 |
<windowTitle> |
String |
2.3 |
外部参照 HTML 文件的窗口标题。 默认值为: ${project.name} ${project.version} Reference 。 |
参数详情
<底部>
外部参照 HTML 文件底部使用的字符串。
- 类型:
java.lang.String
- 自:
2.3
- 必需:
No
- 用户属性:
bottom
- 默认:
Copyright © {inceptionYear}–{currentYear} {organizationName}. All rights reserved.
<目标目录>
外部参照文件将被复制到的文件夹。
- 类型:
java.lang.String
- 自:
2.3
- 必需:
No
- 默认:
${project.reporting.outputDirectory}/xref-test
<文档标题>
外部参照 HTML 文件的主页标题。
- 类型:
java.lang.String
- 自:
2.3
- 必需:
No
- 默认:
${project.name} ${project.version} Reference
<不包括>
要使用的排除模式列表。默认情况下不排除任何文件。
- 类型:
java.util.ArrayList
- 自:
2.1
- 必需:
No
<包括>
要使用的包含模式列表。默认情况下,所有 .java 文件都包括在内。
- 类型:
java.util.ArrayList
- 自:
2.1
- 必需:
No
<输入编码>
文件输入编码。
- 类型:
java.lang.String
- 自:
2.3
- 必需:
No
- 用户属性:
encoding
- 默认:
${project.build.sourceEncoding}
<javadoc版本>
要使用的 Javadoc 模板的版本。该值应反映“java.specification.version”、“1.4”、“1.8”、“9”、“10”,默认情况下使用此系统属性。
- 类型:
java.lang.String
- 自:
2.3
- 必需:
No
- 用户属性:
javadocVersion
<链接Javadoc>
从源外部参照链接 Javadoc。默认为 true,如果正在使用 javadoc 插件,将自动链接。
- 类型:
boolean
- 自:
2.3
- 必需:
No
- 默认:
true
<输出目录>
将生成报告主页的输出文件夹。请注意,仅当目标直接从命令行或默认生命周期运行时,此参数才相关。如果目标作为站点生成的一部分间接运行,则将使用在 Maven 站点插件中配置的输出目录。
- 类型:
java.io.File
- 自:
2.3
- 必需:
Yes
- 默认:
${project.reporting.outputDirectory}
<输出编码>
文件输出编码。
- 类型:
java.lang.String
- 自:
2.3
- 必需:
No
- 用户属性:
outputEncoding
- 默认:
${project.reporting.outputEncoding}
<跳过>
是否跳过此执行。
- 类型:
boolean
- 自:
2.3
- 必需:
No
- 用户属性:
maven.jxr.skip
- 默认:
false
<样式表>
用于外部参照 HTML 文件的样式表。不应该使用。如果使用,应该是绝对路径,例如
"${basedir}/myStyles.css"
.- 类型:
java.lang.String
- 自:
2.3
- 必需:
No
<模板目录>
可以找到 Velocity 模板以生成概览、框架和摘要的目录。不应该使用。如果使用,应该是绝对路径,例如
"${basedir}/myTemplates"
.- 类型:
java.lang.String
- 自:
2.3
- 必需:
No
<testJavadocDir>
为此项目生成测试 Javadoc 的文件夹。
- 类型:
java.io.File
- 自:
2.3
- 必需:
No
- 默认:
${project.reporting.outputDirectory}/testapidocs
<窗口标题>
外部参照 HTML 文件的窗口标题。
- 类型:
java.lang.String
- 自:
2.3
- 必需:
No
- 默认:
${project.name} ${project.version} Reference