Narzędzia interfejsu API - Zadanie Ant generowania pliku

Przeznaczenie

To zadanie jest uruchamiane w celu wygenerowania wszystkich plików wymaganych przez Narzędzia interfejsu API wewnątrz pakunku binarnego. To zadanie jest uruchamiane podczas budowania w środowisku Eclipse lub podczas eksportowania pakunku dla wszystkich projektów rodzaju Narzędzia interfejsu API.

Obecnie tworzony jest tylko plik o nazwie .api_description.

Użycie

Opis

Nazwa zadania Ant to apitooling.apigeneration. Aby możliwe było jego użycie, plik JAR apitooling-ant.jar musi znajdować się w ścieżce klas narzędzia Ant.

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

Parametry

Atrybut Opis Wymagany
projectname Umożliwia ustawienie nazwy projektu. Tak
project Umożliwia ustawienie położenia projektu.

Jest to folder zawierający wszystkie pliki źródłowe dla danego projektu.

Położenie jest określane przy użyciu pełnej ścieżki.
Tak
binary Umożliwia ustawienie położeń danych binarnych.

Jest to lista folderów lub plików JAR zawierających wszystkie pliki .class dla danego projektu. Są one rozdzielone separatorem ścieżek dla danej platformy. Muszą istnieć wszystkie pozycje.

Do określenia ich położenia należy użyć pełnych ścieżek.
Tak
cel Umożliwia ustawienie położenia docelowego.

Jest to folder, w którym generowane są pliki.

Położenie jest określane przy użyciu pełnej ścieżki.
Tak
debug Ustawia wartość debugowania.

Możliwe wartości to: true i false.
Wartość domyślna to false.
Nie
extraManifests Umożliwia ustawienie położeń dodatkowych plików manifestu.

Jest to lista położeń dodatkowych plików MANIFEST.MF, które można ustawić w celu udostępnienia większej liczby pakietów interfejsu API do skanowania. Są one rozdzielone separatorem ścieżek dla danej platformy. Muszą istnieć wszystkie pozycje.

Jeśli ścieżka nie jest pełna, zostanie rozstrzygnięta względem bieżącego katalogu roboczego.

Pliki JAR można określić zamiast pliku MANIFEST.MF. Jeśli plik JAR jest określony, jego plik MANIFEST.MF zostanie odczytany, jeśli istnieje.
Nie
extraSourceLocations Umożliwia ustawienie położeń dodatkowych źródeł.

Jest to lista położeń plików źródłowych, które będą przeglądane. Są one rozdzielone separatorem ścieżek dla danej platformy. Muszą istnieć wszystkie pozycje.

Do określenia ich położenia należy użyć pełnych ścieżek.
Nie
allowNonapiproject Umożliwia uruchomienie zadania na projektach bez włączonej opcji Narzędzia interfejsu API.

Jeśli zadanie zostało uruchomione na projekcie w rodzaju innym niż Narzędzia interfejsu API, zostaje wygenerowany plik api_description, gdyż przyjmuje się, że projekt nie obsługuje narzędzi interfejsu API. W niektórych przypadkach istnieje potrzeba wygenerowania pliku opisu związanego z projektem bez określonego rodzaju. Ustawienie tego parametru na wartość true powoduje, że zadanie nie sprawdza rodzaju projektu.
Nie

Przykłady

 <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"
 />

W powyższym przykładzie zostanie utworzony plik o nazwie .api_description wewnątrz folderu d:\plugins\org.eclipse.jdt.core w oparciu o źródło zawarte w plikach d:\eclipse\org.eclipse.jdt.core oraz .class w katalogu d:\eclipse\org.eclipse.jdt.core\bin.

Informacje pokrewne

Zadanie Ant analizy
Zadanie Ant blokowania interfejsu API
Zadanie Ant użycia interfejsu API
Zadanie Ant konwersji raportu analizy
Zadanie Ant konwersji raportu blokowania interfejsu API
Zadanie Ant deaktualizowania interfejsu API
Zadanie Ant konwersji raportu deaktualizowania interfejsu API
Zadanie Ant konwersji raportu użycia interfejsu API