API-verktøy - Ant-oppgave for filgenerering

Formål

Denne oppgaven kjører for å generere alle filer som kreves av API-verktøy i en binær bunt. Denne oppgaven kjøres under Eclipse-bygginger eller under bunteksporten for alle prosjekter som har en API-verktøy-natur.

For øyeblikket opprettes kun filen som heter .api_description.

Bruk

Beskrivelse

Navnet på Ant-oppgaven er: apitooling.apigeneration. Når den skal brukes, må jar-filen apitooling-ant.jar være i Ant-klassebanen.

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

Parametere

Attributt Beskrivelse Obligatorisk
projectname Oppgi prosjektnavnet Ja
prosjekt Oppgi prosjektplasseringen.

Denne mappen inneholder alle kildefilene til det gitte prosjektet.

Plasseringen angis med en absolutt bane.
Ja
binær Angi plasseringene til binærfilene.

Dette er en liste med mapper eller jar-filer som inneholder alle *.class-filene til det oppgitte prosjektet. De er atskilt av plattformens baneskilletegn. Oppføringen må finnes.

De må oppgis med absolutte baner.
Ja
mål Oppgi målplasseringen.

I denne mappen genereres de genererte filene.

Plasseringen angis med en absolutt bane.
Ja
debug Angi feilsøkingsverdien.

Mulige verdier er true og false
Standardverdien er false.
Nei
extraManifests Oppgi plasseringen til de ekstra manifestfilene.

Dette er en liste med plasseringer for MANIFEST.MF-ekstrafiler. Denne kan oppgis slik at det er mulig å søke i flere API-pakker. De er atskilt av plattformens baneskilletegn. Oppføringen må finnes.

Hvis banen ikke er absolutt, blir den behandlet relativt til gjeldende arbeidskatalog.

JAR-filer kan oppgis i stedet for MANIFEST.MF-filen. Hvis du oppgir en JAR-fil, blir dens MANIFEST.MF-fil lest hvis den eksisterer.
Nei
extraSourceLocations Oppgi flere kildeplasseringer.

Dette er en liste med plasseringer til kildefiler som det skal søkes i. De er atskilt av plattformens baneskilletegn. Oppføringen må finnes.

De må oppgis med absolutte baner.
Nei
allowNonapiproject Tillat at oppgaven kjøres i prosjekter som ikke er aktivert for API-verktøy.

Hvis denne oppgaven kjøres i et prosjekt som ikke har en API-verktøynatur, blir det ikke generert noen api_description-fil fordi det blir antatt at prosjektet ikke støtter API-verktøy. I enkelte tilfeller er det nødvendig å generere beskrivelsesfilen for prosjekter som ikke har naturen. Hvis du setter denne parameteren til true, sjekker ikke oppgaven naturen.
Nei

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

Dette oppretter en fil som heter .api_description, i mappen d:\plugins\org.eclipse.jdt.core basert på kilden som er i d:\eclipse\org.eclipse.jdt.core og .class-filene som er i d:\eclipse\org.eclipse.jdt.core\bin.

Beslektet referanse

Ant-oppgave for analyse
Ant-oppgave for API-frys
Ant-oppgave for API-bruk
Ant-oppgave for konvertering av analyserapport
Ant-oppgave for konvertering av rapport for API-frys
Ant-oppgave for API-foreldelse
Ant-oppgave for konvertering av rapport for API-foreldelse
Ant-oppgave for konvertering av rapport for API-bruk