API fogyasztó használati jelentés átalakítása Ant feladat

Cél

Ez a feladat HTML fájlokká alakítja az apitooling.apiuse Ant feladat által létrehozott XML jelentéseket. A HTML jelentés a hivatkozást felhasználó (például az API-ra vagy típusra hivatkozó kódot tartalmazó) kötegek szerint rendezi a hivatkozásokat.

Használat

Leírás

Az Ant feladat neve: apitooling.apiconsumeruse_reportconversion. A használatához az apitooling-ant.jar fájlnak szerepelnie kell az Ant osztályútvonalon.

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

Paraméterek

Attribútum Leírás Kötelező
xmlfiles Ez az attribútum határozza meg az átalakítandó XML fájlok helyét.

A helyet abszolút útvonalként kell megadni.
Igen
htmlfiles Ez az attribútum határozza meg az előállítandó html fájlok helyét.

A helyet abszolút útvonalként kell megadni.
Igen
xsltfile Ez az attribútum adja meg a kívánt sorrendben lévő hivatkozási részletek oldal előállításához használandó XSLT fájl helyét.

Az apitooling-ant.jar JAR fájl tartalmaz egy alapértelmezett XSLT fájlt.

A helyet abszolút útvonalként kell megadni.
Nem
filterpatterns Ez az attribútum a reguláris kifejezés minták vesszővel elválasztott listáját határozza meg, melyek a megfelelő név mintákból származó referenciákat tisztítják ki a végleges jelentésből.

A mintáknak jól formázott reguláris kifejezéseknek kell lenniük (meghatározás itt).
Nem
tofilterpatterns Ez az attribútum a reguláris kifejezés minták vesszővel elválasztott listáját határozza meg, melyek a megfelelő név mintákra mutató referenciákat tisztítják ki a végleges jelentésből.

A mintáknak jól formázott reguláris kifejezéseknek kell lenniük (meghatározás itt).
Nem
debug Itt állíthatja be a hibakeresési értéket.

Lehetséges értékek: true vagy false
Az alapértelmezett érték a false.
Nem

Példák

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

 />

Ez lefuttatja a feladatot, és az XML fájl helyének mappaszerkezetét követő sorrendben létrehozza a *.html fájlokat az /eclipse/apiuse-both/HTML mappában.

Ha engedélyezve van a hibakeresés, az Ant konzolon hibakeresési nyomkövetési információk is megjelennek.

Kapcsolódó leírások

API használat jelentés átalakítása Ant feladat
Elemzés Ant feladat
Fájl előállítása Ant feladat
API használat Ant feladat
API befagyasztás Ant feladat
API elavulás Ant feladat
API elavulás jelentés átalakítása Ant feladat
Elemzési jelentés átalakítása Ant feladat