jxr：测试-jxr

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

全名：

org.apache.maven.plugins:maven-jxr-plugin:2.2:test-jxr

说明：

为项目的测试源创建基于 html、交叉引用的 Java 源代码版本。

属性：

  • 需要执行 Maven 2.0 项目。

必需参数

姓名 类型 自从 描述
输出目录 File - 将生成报告主页的输出文件夹。请注意，仅当目标直接从命令行或默认生命周期运行时，此参数才相关。如果目标作为站点生成的一部分间接运行，则将使用在 Maven 站点插件中配置的输出目录。

可选参数

姓名 类型 自从 描述
总计的 boolean - 是在根目录构建聚合报告，还是构建单独的报告。
默认值为：false。
底部 String - 外部参照 HTML 文件底部使用的字符串。
默认值为：Copyright © {inceptionYear}-{currentYear} {projectOrganizationName}. All Rights Reserved.。
目标目录 String - 外部参照文件将被复制到的文件夹。
文档标题 String - 外部参照 HTML 文件的主页标题。
排除 ArrayList 2.1 要使用的排除模式列表。默认情况下不排除任何文件。
包括 ArrayList 2.1 要使用的包含模式列表。默认情况下，所有 .java 文件都包括在内。
输入编码 String - 文件输入编码。
默认值为：${project.build.sourceEncoding}。
链接Javadoc boolean - 从源外部参照链接 Javadoc。默认为 true，如果正在使用 javadoc 插件，将自动链接。
默认值为：true。
输出编码 String - 文件输出编码。
默认值为：${project.reporting.outputEncoding}。
样式表 String - 用于外部参照 HTML 文件的样式表。不应该使用。如果使用，应该是绝对路径，例如 "${basedir}/myStyles.css".
默认值为：stylesheet.css。
模板目录 String - 可以找到 Velocity 模板以生成概览、框架和摘要的目录。不应该使用。如果使用，应该是绝对路径，例如 "${basedir}/myTemplates".
默认值为：templates。
测试JavadocDir File - 为此项目生成测试 Javadoc 的文件夹。
窗口标题 String - 外部参照 HTML 文件的窗口标题。

参数详情

聚合：

是在根目录构建聚合报告，还是构建单独的报告。
  • 类型：boolean
  • 必需：No
  • 表达式：${aggregate}
  • 默认：false

底部：

外部参照 HTML 文件底部使用的字符串。
  • 类型：java.lang.String
  • 必需：No
  • 表达式：${bottom}
  • 默认：Copyright © {inceptionYear}-{currentYear} {projectOrganizationName}. All Rights Reserved.

目标目录：

外部参照文件将被复制到的文件夹。
  • 类型：java.lang.String
  • 必需：No
  • 表达式：${project.reporting.outputDirectory}/xref-test

文档标题：

外部参照 HTML 文件的主页标题。
  • 类型：java.lang.String
  • 必需：No
  • 表达式：${project.name} ${project.version} Reference

不包括：

要使用的排除模式列表。默认情况下不排除任何文件。
  • 类型：java.util.ArrayList
  • 自：2.1
  • 必需：No
  • 表达式：${excludes}

包括：

要使用的包含模式列表。默认情况下，所有 .java 文件都包括在内。
  • 类型：java.util.ArrayList
  • 自：2.1
  • 必需：No
  • 表达式：${includes}

输入编码：

文件输入编码。
  • 类型：java.lang.String
  • 必需：No
  • 表达式：${encoding}
  • 默认：${project.build.sourceEncoding}

链接Javadoc：

从源外部参照链接 Javadoc。默认为 true，如果正在使用 javadoc 插件，将自动链接。
  • 类型：boolean
  • 必需：No
  • 表达式：${linkJavadoc}
  • 默认：true

输出目录：

将生成报告主页的输出文件夹。请注意，仅当目标直接从命令行或默认生命周期运行时，此参数才相关。如果目标作为站点生成的一部分间接运行，则将使用在 Maven 站点插件中配置的输出目录。
  • 类型：java.io.File
  • 必需：Yes
  • 表达式：${project.reporting.outputDirectory}

输出编码：

文件输出编码。
  • 类型：java.lang.String
  • 必需：No
  • 表达式：${outputEncoding}
  • 默认：${project.reporting.outputEncoding}

样式表：

用于外部参照 HTML 文件的样式表。不应该使用。如果使用，应该是绝对路径，例如 "${basedir}/myStyles.css".
  • 类型：java.lang.String
  • 必需：No
  • 默认：stylesheet.css

模板目录：

可以找到 Velocity 模板以生成概览、框架和摘要的目录。不应该使用。如果使用，应该是绝对路径，例如 "${basedir}/myTemplates".
  • 类型：java.lang.String
  • 必需：No
  • 默认：templates

测试JavadocDir：

为此项目生成测试 Javadoc 的文件夹。
  • 类型：java.io.File
  • 必需：No
  • 表达式：${project.reporting.outputDirectory}/testapidocs

窗口标题：

外部参照 HTML 文件的窗口标题。
  • 类型：java.lang.String
  • 必需：No
  • 表达式：${project.name} ${project.version} Reference