執行這項作業是為了要在二進位軟體組內產生「API 工具」所需的一切檔案。這項作業是在 Eclipse 建置期間或在軟體組匯出期間,針對具有「API 工具」本質的所有專案來執行。
目前,只會建立 .api_description 檔。
Ant 作業的名稱為:apitooling.apigeneration。如果要能夠使用,JAR 檔 apitooling-ant.jar 必須在 Ant 類別路徑上。
<apitooling.apigeneration
projectname="..."
project="..."
binary="..."
target="..."
debug="..."
/>
| 屬性 | 說明 | 必要 |
| projectname | 設定專案名稱 | 是 |
| 專案 |
設定專案位置。
這是包含給定專案之所有原始檔的資料夾。 此位置是使用絕對路徑設定的。 |
是 |
| 二進位 |
設定二進位位置。
這是資料夾或 Jar 檔的清單,其包含給定的專案的所有 .class 檔案。 它們會以平台路徑分隔字元來區隔。每一個項目都必須存在。 必須使用絕對路徑指定它們。 |
是 |
| target |
設定目標位置。
這是所產生檔案在產生時所在的資料夾。 此位置是使用絕對路徑設定的。 |
是 |
| 除錯 |
設定除錯值。
可能的值為: true、false預設值是 false。 |
否 |
| extraManifests |
設定額外資訊清單檔的位置。
這是額外 MANIFEST.MF 檔案位置的清單,可設定來提供更多要掃描的 api 套件。 它們會以平台路徑分隔字元來區隔。每一個項目都必須存在。 如果路徑不是絕對路徑,就會相對於現行工作目錄來解析路徑。 可以指定 JAR 檔,而不指定 MANIFEST.MF 檔。 如果指定 JAR 檔,當它的 MANIFEST.MF 檔存在時會被讀取。 |
否 |
| extraSourceLocations |
設定額外來源位置。
這是要掃描的原始檔位置清單。 它們會以平台路徑分隔字元來區隔。每一個項目都必須存在。 必須使用絕對路徑指定它們。 |
否 |
| allowNonapiproject |
容許在啟用「非 API 工具」的專案上執行作業。
如果是在不具備「API 工具」本質的專案上執行這個作業,就不會產生 api_description 檔,因為這時假設專案不支援「API 工具」。 在某些情況下,必須在不具備 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 作業