Статьи

Самостоятельная работа с отчетами об инструментах API (часть II): создание отчета об использовании API с помощью задачи Ant


Отчет об использовании API также может быть создан с помощью задач Ant. См. Справочную документацию по Eclipse
здесь . Если вы уже знаете, как запускать задачи Ant в Eclipse, пропустите оставшуюся часть.

1. Написание сценария Ant

Я предполагаю, что вы уже немного знаете Ant. Если нет, остановитесь и перейдите к
Муравейнику .

Создайте новый файл и назовите его GenerateApiUseReport.xml. Он откроется в текстовом редакторе по умолчанию. Закройте его и откройте его с помощью Ant Editor (нажмите правой кнопкой мыши на файл и выберите «Открыть с помощью» -> «Другие …»).

Теперь запишите это в файл.

Параметры соответствуют пользовательскому интерфейсу, который мы обсуждали ранее.

Ant Параметры UI

расположение <=> Анализ

scopepattern <=> Связки соответствие

referencepattern <=> Ссылки на

доклад <=> Отчет выводного

considerinternal <=> Внутренние ссылки

considerapi <=> ссылки API

considerillegaluse <=> Illegal Использование API

Эти два не являются в UI

archivepatterns — его исключить фильтр. Это будет список, разделенный запятыми, в формате <bundle-id>: <относительный-путь-к-jar>

debug — с указанием «true»
сделает
apitooling.apiuse Задача муравья выдает всю информацию трассировки отладки. Это может быть полезно, если по какой-то причине результаты не ожидаются, и вам необходимо провести расследование. Поскольку значение по умолчанию равно false, я бы рекомендовал не указывать его, пока оно вам не понадобится и вы не узнаете, что делаете.

2. Запуск скрипта

Это просто. Вы должны создать новую конфигурацию запуска Ant Build из мастера настройки внешних инструментов. Но зачем это делать, когда есть ярлык. Просто щелкните правой кнопкой мыши в редакторе муравьев и выберите «Запуск от имени» -> «2. Муравей Build … ‘. Это автоматически создаст конфигурацию запуска Ant Build для вас и откроет ее. Это будет выглядеть так


Нажмите Run, чтобы выполнить скрипт. Вы можете открыть это снова из мастера настройки External Tools.

3. Создание HTML отчетов

В
apitooling.apiuse муравей задачу только генерирующий отчет XML. Для генерации отчетов HTML нам нужно вызвать 
задачу
apitooling.apiuse_reportconversion . Параметры очень просты. Смотрите документацию
здесь .

Поскольку мы хотели бы сделать это вместе только с генерацией отчетов. Мы можем добавить это к тому же скрипту Ant и

сделать так, чтобы он выглядел следующим образом

<project default="ApiUseTarget">
<target name="ApiUseTarget">
<apitooling.apiuse considerapi="true" considerillegaluse="true" considerinternal="true" location="C:\MyRCPProduct\eclipse" referencepattern="org\.eclipse\..*" report="C:\MyRCPProduct\Reports\APIUseReport\XML" scopepattern="com\.example\..*">
<apitooling.apiuse_reportconversion htmlfiles="C:\MyRCPProduct\Reports\APIUseReport\HTML" xmlfiles="C:\MyRCPProduct\Reports\APIUseReport\XML">
</apitooling.apiuse_reportconversion></apitooling.apiuse></target>
</project>

 

От http://blog.ankursharma.org/2011/02/self-help-with-api-tooling-reports-part_04.html