API 工具文件生成 Ant 任务

用途

运行此任务以生成二进制捆绑软件中的 API 工具所需要的所有文件。 在进行 Eclipse 构建期间或者对所有具有 API 工具性质的项目执行捆绑软件导出期间将运行此任务。

目前,仅创建了称为 .api_description 的文件。

用法

描述

Ant 任务的名称为 apitooling.apigeneration。 要使用 JAR 文件 apitooling-ant.jar,此文件必须在 Ant 类路径上。

<apitooling.apigeneration
	projectname="..."
	project="..."
	binary="..."
	target="..."
	debug="..."
/>

参数

属性 描述 是否必需
projectname 设置项目名称。 是
project 设置项目位置。

这是一个文件夹,它包含所给定项目的所有源文件。

使用绝对路径来设置此位置。
是
binary 设置二进制位置。

这是包含所给定项目的所有 .class 文件的文件夹或 JAR 文件的列表。 它们之间用平台路径分隔符分隔。每个条目都必须存在。

应该使用绝对路径来指定这些条目。
是
target 设置目标位置。

这是在其中产生了生成文件的文件夹。

使用绝对路径来设置此位置。
是
debug 设置调试值。

此属性的值可为:true 或 false
缺省值为 false。
否
extraManifests 设置额外清单文件的位置。

这是额外 MANIFEST.MF 文件所在位置的列表,可以设置这些位置以提供更多要扫描的 API 包。它们之间用平台路径分隔符分隔。每个条目都必须存在。

如果不是绝对路径,那么该路径将解析为相对于当前工作目录的路径。

可指定 JAR 文件而不是 MANIFEST.MF 文件。如果指定了 JAR 文件,那么会读取其 MANIFEST.MF 文件(如果该文件存在)。
否
extraSourceLocations 设置额外的源位置。

这是将扫描的源文件所在位置的列表。它们之间用平台路径分隔符分隔。每个条目都必须存在。

应该使用绝对路径来指定这些条目。
否
allowNonapiproject 允许在启用了非 API 工具的项目上运行任务。

如果此任务在一个不具备 API 工具性质的项目上运行,那么将不会生成 api_description 文件,这是因为它假定此项目不支持 API 工具。 在某些情况下,需要对不具备此性质的项目生成描述文件。 将此参数设置为 true 将导致此任务不检查性质。
否

示例

 <apitooling.apigeneration
  projectname="org.eclipse.jdt.core_3.5.0.v_927"
  project="d:\eclipse\org.eclipse.jdt.core"

  binary="d:\eclipse\org.eclipse.jdt.core\bin;d:\eclipse\org.eclipse.jdt.core\antbin"
  target="d:\plugins\org.eclipse.jdt.core"
  debug="true"
 />

这将根据 d:\eclipse\org.eclipse.jdt.core 中包含的源以及 d:\eclipse\org.eclipse.jdt.core\bin 中包含的 .class 文件在 d:\plugins\org.eclipse.jdt.core 文件夹中创建一个名为 .api_description 的文件。

相关参考

分析 Ant 任务
API 冻结 Ant 任务
API 使用 Ant 任务
分析报告转换 Ant 任务
API 冻结报告转换 Ant 任务
API 不推荐 Ant 任务
API 不推荐报告转换 Ant 任务
API 使用报告转换 Ant 任务