API-verktyg - Ant-uppgiften File Generation

Ändamål

Uppgiften körs för att generera alla filer som krävs för API-verktyg i ett binärt samlingspaket. Den körs under Eclipse-byggen eller under samlingspaketexporten för alla projekt av API-verktygsnatur.

För tillfället skapas endast filen .api_description.

Användning

Beskrivning

Ant-uppgiftens namn: apitooling.apigeneration. Om den ska kunna användas måste JAR-filen apitooling-ant.jar finnas i Ant-klassökvägen.

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

Parametrar

Attribut Beskrivning Obligatoriskt
projectname Projektnamnet Ja
project Projektplatsen

Den mapp som innehåller alla källfiler för ett projekt.

Platsen anges med en absolut sökväg.
Ja
binary Binära platser

En lista över mappar eller JAR-filer som innehåller alla .class-filer för projektet. De separeras med sökvägsavgränsaren för plattformen. Alla poster måste finnas.

De ska anges med absoluta sökvägar.
Ja
target Målplatsen

Det är mappen där de genererade filerna skapas.

Platsen anges med en absolut sökväg.
Ja
debug Felsökningsvärdet

Giltiga värden är: true, false
Standardvärdet är false.
Nej
extraManifests Platserna för extra manifestfiler

En lista över extra MANIFEST.MF-filplatser som kan anges för fler API-paket som ska kontrolleras. De separeras med sökvägsavgränsaren för plattformen. Alla poster måste finnas.

Om sökvägen inte är absolut kommer den att tolkas relativ den aktuella arbetskatalogen.

JAR-filer kan anges i stället för filen MANIFEST.MF. Om en JAR-fil anges, kommer dess fil MANIFEST.MF att läsas om den finns.
Nej
extraSourceLocations Platserna för extra källfiler

En lista över platser för källfiler som ska kontrolleras. De separeras med sökvägsavgränsaren för plattformen. Alla poster måste finnas.

De ska anges med absoluta sökvägar.
Nej
allowNonapiproject Tillåt uppgiften att köra i projekt som inte är aktiverade för API-verktyg.

Om uppgiften körs i ett projekt som inte har API-verktygsnaturen, kommer filen api_description att genereras eftersom det antas att projektet inte hanterar API-verktyg. I vissa fall behöver beskrivningsfilen genereras på projekt utan natur. Om parametern ges värdet true kontrollerar uppgiften inte om det finns en natur.
Nej

Exempel

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

Filen .api_description skapas i mappen d:\plugins\org.eclipse.jdt.core baserat på källan i d:\eclipse\org.eclipse.jdt.core och .class-filerna i d:\eclipse\org.eclipse.jdt.core\bin.

Närliggande referenser

Ant-uppgiften Analysis
Ant-uppgiften API Freeze
Ant-uppgiften API Use
Ant-uppgiften Analysis Report Conversion
Ant-uppgiften API Freeze Report Conversion
Ant-uppgiften API Deprecation
Ant-uppgiften API Deprecation Report Conversion
Ant-uppgiften API Use Report Conversion