Tarefa Ant de conversão de relatórios de utilização do consumidor da API

Finalidade

Esta tarefa converte o relatório XML criado pela tarefa Ant apitooling.apiuse em ficheiros HTML. O relatório HTML organiza referências pelo lote que consome a referência (isto é, contém o código que faz referência à api/tipo).

Utilização

Descrição

O nome da tarefa Ant é: apitooling.apiconsumeruse_reportconversion. Para ser utilizado, o ficheiro jar apitooling-ant.jar tem de estar no caminho de classes Ant.

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

Parâmetros

Atributo Descrição Necessário
xmlfiles Este atributo especifica a localização dos ficheiros xml a serem convertidos.

A localização é especificada utilizando um caminho absoluto.
Sim
htmlfiles Este atributo especifica a localização dos ficheiros html a serem criados.

A localização é especificada utilizando um caminho absoluto.
Sim
xsltfile Este atributo especifica a localização do ficheiro XSLT a ser utilizado para gerar as páginas de detalhes de referências por uma ordem que se pretenda.

Um ficheiro XSLT está disponível no ficheiro Jar apitooling-ant.jar.

A localização é especificada utilizando um caminho absoluto.
Não
filterpatterns Este atributo especifica uma listagem separada por vírgulas de padrões de expressão regulares utilizada para aperfeiçoar referências de padrões de nomes correspondentes a partir do relatório final.

O padrão tem de ser uma expressão regular bem formatada conforme se define aqui.
Não
tofilterpatterns Este atributo especifica uma listagem separada por vírgulas de padrões de expressões regulares utilizada para aperfeiçoar referências a padrões de nomes correspondentes do relatório final.

O padrão tem de ser uma expressão regular bem formatada conforme se define aqui.
Não
debug Define o valor de depuração.

Os valores possíveis são: true, false
A predefinição é false.
Não

Exemplos

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

 />

Isto irá executar a tarefa que cria os ficheiros *.html dentro da pasta /eclipse/apiuse-both/HTML que corresponde à estrutura de pastas da localização de ficheiros XML

Se a depuração estiver activada, aparecerá alguma indicação de rastreio na consola ant.

Referência relacionada

Tarefa ant de conversão de relatórios de utilização da API
Tarefa ant de análise
Tarefa ant de geração de ficheiros
Tarefa ant de utilização da API
Tarefa ant de congelamento da API de Ferramentas API
Tarefa ant de desactualização da API
Tarefa ant de conversão de relatórios de desactualização da API
Tarefa ant de conversão de relatórios de análise