Ant-uppgiften API Use Report Conversion

Ändamål

Uppgiften konverterar XML-rapporten som har skapats av Ant-uppgiften apitooling.apiuse till HTML-filer. I HTML-rapporten ordnas referenserna efter det paket som producerar dem (dvs. det paket som innehåller den api/typ som refereras till).

Användning

Beskrivning

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

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

Parametrar

Attribut Beskrivning Obligatoriskt
xmlfiles Attributet anger platsen för XML-filer som ska konverteras.

Platsen anges med en absolut sökväg.
Ja
htmlfiles Attributet anger platsen för HTML-filerna som ska genereras.

Platsen anges med en absolut sökväg.
Ja
xsltfile Attributet anger platsen för en XSLT-fil som ska användas till att generera referensdetaljsidorna i önskad ordning.

Det finns en XSLT-standardfil i JAR-filen apitooling-ant.jar.

Platsen anges med en absolut sökväg.
Nej
filterpatterns Attributet anger en kommaavgränsad lista över reguljära uttrycksmönster som trimmar referenser från matchande namnmönster från slutrapporten.

Mönstret måste vara ett giltigt reguljärt uttryck, vilket definieras här.
Nej
tofilterpatterns Attributet anger en kommaavgränsad lista över reguljära uttrycksmönster som trimmar referenser från matchande namnmönster till slutrapporten.

Mönstret måste vara ett giltigt reguljärt uttryck, vilket definieras här.
Nej
debug Felsökningsvärdet

Giltiga värden är: true, false
Standardvärdet är false.
Nej

Exempel

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

 />

Uppgiften som skapar *.html-filer i mappen /eclipse/apiuse-both/HTML som motsvarar mappstrukturen i XML-filplatsen.

Om debug är aktiverat visas vissa felsökningsmeddelanden i Ant-konsolen.

Närliggande referenser

Ant-uppgiften API Consumer Use Report Conversion
Ant-uppgiften Analysis
Ant-uppgiften File Generation
Ant-uppgiften API Use
Ant-uppgiften API Freeze
Ant-uppgiften API Deprecation
Ant-uppgiften API Deprecation Report Conversion
Ant-uppgiften Analysis Report Conversion