Tâche Ant de conversion de rapport d'utilisation d'API

Objectif

Cette tâche convertit le rapport XML créé par la tâche Ant apitooling.apiuse en fichiers HTML. Le rapport HTML organise les références par le regroupement qui les a produites (c'est-à-dire le regroupement qui contient l'API/le type référencé).

Syntaxe

Description

Le nom de la tâche Ant est apitooling.apiuse_reportconversion. Pour qu'il puisse être utilisé, le fichier jar apitooling-ant.jar doit figurer dans le chemin d'accès aux classes Ant.

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

Paramètres

Attribut Description Obligatoire
xmlfiles Cet attribut définit l'emplacement des fichiers xml à convertir.

L'emplacement est défini en utilisant un chemin absolu.
Oui
htmlfiles Cet attribut définit l'emplacement du fichier html à générer.

L'emplacement est défini en utilisant un chemin absolu.
Oui
xsltfile Cet attribut spécifie l'emplacement d'un fichier XSLT à utiliser pour générer les pages de détails de référence dans un ordre donné.

Un fichier XSLT par défaut se trouve dans le fichier JAR apitooling-ant.jar.

L'emplacement est défini en utilisant un chemin absolu.
Non
filterpatterns Cet attribut spécifie une liste de masques d'expression régulière séparés par des virgules utilisée pour supprimer du rapport final les références provenant des masques de nom correspondants.

Ce masque doit être une expression régulière syntaxiquement correcte conforme aux spécifications définies ici.
Non
tofilterpatterns Cet attribut spécifie une liste de masques d'expression régulière séparés par des virgules utilisée pour supprimer du rapport final les références aux masques de nom correspondants.

Ce masque doit être une expression régulière syntaxiquement correcte conforme aux spécifications définies ici.
Non
debug Définit la valeur de débogage.

Les valeurs possibles sont true, false
La valeur par défaut est false.
Non

Exemples

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

 />

Cet exemple exécute la tâche en créant des fichiers *.html dans le dossier /eclipse/apiuse-both/HTML correspondant à la structure de dossier de l'emplacement des fichiers XML

Si le débogage est activé, un traçage de débogage apparaît dans la console Ant.

Référence connexe

Tâche Ant de conversion de rapport d'utilisation de consommateur d'API
Tâche Ant d'analyse
Tâche Ant de génération de fichier
Tâche Ant d'utilisation d'API
Tâche Ant de gel d'API
Tâche Ant de dépréciation d'API
Tâche Ant de conversion de rapport de dépréciation d'API
Tâche Ant de conversion de rapport d'analyse