Ant-opgave: Konvertering af API-forbrugerbrugsrapport

Formål

Denne opgave konverterer XML-rapporten, som er oprettet af Ant-opgaven apitooling.apiuse, til HTML-filer. HTML-rapporten organiserer referencer efter det bundt, der forbruger referencen (dvs. indeholder den kode, der refererer til api/type).

Brug

Beskrivelse

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

 <apitooling.apiconsumeruse_reportconversion
	xmlfiles="..."
	htmlfiles="..."
	xsltfile="..."
	filterpatterns="..."
	tofilterpatterns="..."
	debug="..."
 />

Parametre

Attribut Beskrivelse Påkrævet
xmlfiles Denne attribut angiver placeringen af de XML-filer, der skal konverteres.

Placeringen angives ved hjælp af en absolut sti.
Ja
htmlfiles Denne attribut angiver placeringen af de HTML-filer, der skal genereres.

Placeringen angives ved hjælp af en absolut sti.
Ja
xsltfile Denne attribut angiver placeringen af en XSLT-fil, der skal bruges til at generere siderne med referenceoplysninger i en bestemt rækkefølge.

Der findes en XSLT-standardfil i JAR-filen apitooling-ant.jar.

Placeringen angives ved hjælp af en absolut sti.
Nej
filterpatterns Denne attribut angiver en kommasepareret liste over regulære udtryksmønstre, der bruges til at beskære referencer fra matchende navnemønstre fra den endelige rapport.

Mønsteret skal være et korrekt formateret regulært udtryk som defineret her.
Nej
tofilterpatterns Denne attribut angiver en kommasepareret liste over regulære udtryksmønstre, der bruges til at beskære referencer til matchende navnemønstre fra den endelige rapport.

Mønsteret skal være et korrekt formateret regulært udtryk som defineret her.
Nej
debug Angiv fejlfindingsværdien.

Mulige værdier er: true, false
Standardværdien er false.
Nej

Eksempler

 <apitooling.apiuse_reportconversion
  xmlfiles="/eclipse/apiuse-both/XML"
  htmlfiles="/eclipse/apiuse-both/HTML"
  xsltfile="/eclipse/references.xsl"
  debug="true"

 />

Herved køres den opgave, som opretter *.html-filer i folderen /eclipse/apiuse-both/HTML, svarende til folderstrukturen for XML-filens placering.

Hvis fejlfinding er aktiveret, bliver der vist fejlfindingssporing i Ant-konsollen.

Relaterede referencer

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