Tarefa Ant de Conversão do Relatório de Uso da API

Propósito

Esta tarefa converte o relatório XML criado pela tarefa Ant apitooling.apiuse em arquivos HTML. O relatório HTML organizará as referências pelo pacote configurável que as produziu (ou seja, o pacote configurável que contém a(o) API/tipo que está sendo referenciada(o)).

Uso

Descrição

O nome da tarefa Ant é: apitooling.apiuse_reportconversion. Para ser usado, o arquivo jar apitooling-ant.jar deve estar no caminho de classe Ant.

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

Parâmetros

Atributo Descrição Necessário
xmlfiles Este atributo especifica o local dos arquivos xml a converter.

O local é especificado usando um caminho absoluto.
Sim
htmlfiles Este atributo especifica o local dos arquivos html a gerar.

O local é especificado usando um caminho absoluto.
Sim
xsltfile Este atributo especifica o local de um arquivo XSLT a ser usado para gerar as páginas de detalhes de referência em uma ordenação desejada.

UM arquivo XSLT padrão está disponível no arquivo JAR apitooling-ant.jar.

O local é especificado usando um caminho absoluto.
Não
filterpatterns Este atributo especifica uma listagem separada por vírgulas de padrões de expressões regulares para remover referências de correspondentes aos padrões de nome do relatório final.

O padrão deve ser uma expressão regular bem formada, como definido aqui.
Não
tofilterpatterns Este atributo especifica uma listagem separada por vírgulas de padrões de expressões regulares usadas para remover referências para padrões de nomes correspondentes do relatório final.

O padrão deve ser uma expressão regular bem formada, como definido aqui.
Não
depuração Configure o valor da depuração.

Os valores possíveis são: true, false
O padrã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 executará a tarefa criando arquivos *.html dentro da pasta /eclipse/apiuse-both/HTML correspondente à estrutura de pastas do local do arquivo XML

Se a depuração estiver ativada, algum rastreio de depuração será exibido no console Ant.

Referência relacionada

Tarefa Ant de Conversão do Relatório de Uso do Consumidor da API
Tarefa Ant de Análise
Tarefa Ant de Geração de Arquivo
Tarefa Ant de Uso da API
Tarefa Ant de Congelamento da API
Tarefa Ant de Reprovação da API
Tarefa Ant de Conversão do Relatório de Reprovação da API
Tarefa Ant de Conversão do Relatório de Análise