API Tools - Ant-taak Bestanden genereren

Doel

This task runs to generate all files required by API Tools inside a binary bundle. This task is run during the Eclipse builds or during the bundle export for all projects that have an API Tools nature.

Right now, only the file called .api_description is created.

Gebruik

Description

De naam van de ant-taak is apitooling.apigeneration. Om deze te kunnen gebruiken, moet het jar-bestand apitooling-ant.jar in het Ant-klassenpad staan.

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

Parameters

Attribute Beschrijving Required
projectname Projectnaam instellen. Ja
project Instellen van de projectlocatie.

Dit is de map die alle bronbestanden van het betreffende project bevat.

De locatie wordt ingesteld als absoluut pad.
Ja
binary Instellen van de binary-locaties.

Dit is een lijst met mappen of JAR-bestanden die alle class-bestanden van het betreffende project bevat. Deze zijn gescheiden door het padscheidingsteken van het platform. Alle items moeten bestaan.

Deze moeten worden opgegeven als absoluut pad.
Ja
doel Instellen van de doellocatie.

Dit is de map waarin de gegenereerde bestanden worden geplaatst.

De locatie wordt ingesteld als absoluut pad.
Ja
debug Instellen van de foutopsporingswaarde.

De mogelijke waarden zijn true en false.
De standaardwaarde is false.
Nee
extraManifests Instellen van de locaties van extra manifestbestanden.

Dit is een lijst van locaties van extra MANIFEST.MF-bestanden, zodat er meer API-pakketten gescand kunnen worden. Deze zijn gescheiden door het padscheidingsteken van het platform. Alle items moeten bestaan.

Als het pad niet absoluut is, wordt het omgezet ten opzichte van de actuele werkdirectory.

JAR-bestanden kunnen worden opgegeven in plaats van het bestand MANIFEST.MF. Als u een JAR-bestand opgeeft, wordt het bestand MANIFEST.MF gelezen wanneer het aanwezig is.
Nee
extraSourceLocations Instellen van de locaties van extra bronnen.

Dit is een lijst van locaties van bronbestanden die worden gescand. Deze zijn gescheiden door het padscheidingsteken van het platform. Alle items moeten bestaan.

Deze moeten worden opgegeven als absoluut pad.
Nee
allowNonapiproject Allow the task to run on non-API Tools enabled projects.

If this task is run on a project that does not have an API Tools nature, no api_description file will be generated as it is assumed that the project does not support API Tools. In some cases there is a need to generate the description file on projects without the nature. Setting this parameter to true will cause the task to not check for a nature.
Nee

Voorbeelden

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

This will create a file called .api_description inside the folder d:\plugins\org.eclipse.jdt.core based on the source contained in d:\eclipse\org.eclipse.jdt.core and the .class files contained in d:\eclipse\org.eclipse.jdt.core\bin.

Verwante onderwerpen

Analyse Ant-taak
Ant-taak API blokkeren
Ant-taak API-gebruik
Ant-taak Analyserapport converteren
Ant-taak API-blokkeringsrapport converteren
Ant-taak API-depreciatie
Ant-taak API-depreciatie - Rapportconversie
Ant-taak API-gebruiksrapport converteren