API-værktøjer - Ant-opgave: Filgenerering

Formål

Denne opgave genererer alle de filer, som kræves af API-værktøjer, i et binært bundt. Opgaven udføres under Eclipse-bygninger eller under bundteksport for alle projekter, der har projektnaturen API-værktøjer.

I øjeblikket er det kun filen .api_description, der oprettes.

Brug

Beskrivelse

Navnet på Ant-opgaven er: apitooling.apigeneration. For at kunne bruges skal JAR-filen apitooling-ant.jar findes i Ant-classpath.

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

Parametre

Attribut Beskrivelse Påkrævet
projectname Angiv projektnavnet. Ja
project Angiv projektets placering.

Det er den folder, der indeholder alle kildefilerne til et bestemt projekt.

Placeringen angives ved hjælp af en absolut sti.
Ja
binary Angiv de binære placeringer.

Dette er en liste over folder eller JAR-filer, der indeholder alle .class-filer for projektet. De er adskilt af platformens stiskilletegn. Alle indgange skal findes.

De skal angives vha. absolutte stier.
Ja
target Angiv målplaceringen.

Det er den folder, hvor filerne genereres.

Placeringen angives ved hjælp af en absolut sti.
Ja
debug Angiv fejlfindingsværdien.

Mulige værdier er: true, false
Standardværdien er false.
Nej
extraManifests Angiv placeringen af de ekstra manifestfiler.

Det er en liste over placeringerne af de ekstra MANIFEST.MF-filer, som kan angives, hvis du vil levere flere API-pakker til scanning. De er adskilt af platformens stiskilletegn. Alle indgange skal findes.

Hvis stien ikke er absolut, behandles den i forhold til det aktuelle arbejdsbibliotek.

Jar-filer kan angives i stedet for en MANIFEST.MF-fil. Hvis en jar-fil angives, vil dens MANIFEST.MF-fil blive læst, hvis den eksisterer.
Nej
extraSourceLocations Angiv placeringen af de ekstra kildefiler.

Det er en liste over placeringerne af de kildefiler, som skal scannes. De er adskilt af platformens stiskilletegn. Alle indgange skal findes.

De skal angives vha. absolutte stier.
Nej
allowNonapiproject Tillad, at opgaven køres i projekter, der ikke er aktiveret til API-værktøjer.

Hvis opgaven udføres på et projekt, der ikke har projektnaturen API-værktøjer, bliver der ikke genereret nogen api_description-fil, da det antages, at projektet ikke understøtter API-værktøjer. I nogle tilfælde kan det være nødvendigt at generere beskrivelsesfilen på projekter uden denne natur. Hvis parameteren angives til true, vil opgaven ikke kontrollere naturen.
Nej

Eksempler

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

Herved oprettes en fil med navnet .api_description i folderen d:\plugins\org.eclipse.jdt.core, baseret på kilden i d:\eclipse\org.eclipse.jdt.core og .class-filerne i d:\eclipse\org.eclipse.jdt.core\bin.

Relaterede referencer

Ant-opgave: Analyse
API-opgave: API-frys
API-opgave: API-brug
Ant-opgave: Konvertering af analyserapport
Ant-opgave: Konvertering af API-frysrapport
Ant-opgave: API-forældelse
Ant-opgave: Konvertering af API-forældelsesrapport
Ant-opgave: Konvertering af API-brugsrapport