Отчеты об использовании API

Отчет об использовании API описывает набор ссылок из одного набора комплектов на другой. Отчет можно создать путем выполнения задачи Использование API - Задача Ant. Для настройки и создания отчета в окне Внешние инструменты предоставляется пользовательский интерфейс. Для создания новой конфигурации поиска информации об использовании просто дважды щелкните на типе конфигурации Отчет об использовании API.

Использование API - Вкладка Отчет

На вкладке Отчет об использовании API можно настроить анализ.

В следующем примере показана конфигурация, настроенная на извлечение всех ссылок на комплекты Eclipse из версии 3.4.

Вкладка Отчет об использовании API


Опция

Описание

По умолчанию

Проанализировать Можно выбрать объекты для анализа - контрольную версию API, целевое определение или каталог комплектов. Можно также выбрать лишь генерацию файла HTML для существующего отчета. Выбрать можно только одну опцию; каждую опцию можно настраивать. Например, в случае выбора анализа контрольной версии API можно перейти на страницу параметров контрольных версий API и отредактировать существующие контрольные версии. Контрольная версия API
Проанализировать > Контрольная версия API Для анализа можно выбрать любую контрольную версию API Контрольная версия или пустое значение
Проанализировать > Контрольные версии... Разрешает доступ к странице параметров Контрольные версии API для настройки контрольной версии для анализа.  
Проанализировать > Целевое определение Для анализа можно выбрать любое целевое определение Активное целевое определение или пустое значение
Проанализировать > Цели Разрешает доступ к странице параметров Целевая платформа для настройки целевого определения для анализа.  
Проанализировать > Каталог Можно ввести абсолютный путь к каталогу комплектов. Пустое значение
Проанализировать > Обзор... Позволяет выбрать папку комплектов для анализа.  
Проанализировать > Создать отчет HTML о существующем поиске информации об использовании Позволяет создать отчет о существующем поиске, не выполняя повторного анализа.  
Поиск > Ссылки на Позволяет указать имя (или соответствующий RegEx) комплекта, ссылки на который вы хотите просмотреть. Рассмотрите следующий пример: org\.eclipse.*. В этом примере указано, что требуется просмотреть все ссылки на любой комплект, имя которого начинается с org.eclipse.. Пустое значение
Поиск > Ссылки на API Позволяет выполнить поиск ссылок на API. Не отмечена
Поиск > Внутренние ссылки Позволяет выполнить поиск внутренних ссылок. Отмечена
Поиск > Запрещенное использование API Позволяет выполнить поиск информации о запрещенном использовании API, т.е. использовании запрещенных элементов API. Не отмечена
Поиск в > Подходящие комплекты Позволяет указать имя (или соответствующий RegEx) комплекта (или комплектов), в котором требуется выполнить поиск ссылок из, например, диапазона поиска. Рассмотрите следующий пример: .*. В этом примере указано, что требуется выполнить поиск во всех комплектах, имена которых соответствуют произвольной последовательности символов. Того же эффекта можно достичь, если оставить поле пустым. Пустое значение
Формирование отчетов > Тип отчета Позволяет выбрать один из двух форматов отчета html. Если выбран Отчет об упоминаемых комплектах (Источники), в отчете будут показаны все комплекты, содержащие типы, на которые указывают ссылки в комплектах поиска. Если выбран Отчет о ссылающихся комплектах (Приемники), отчет будет сформирован таким образом, чтобы показать все комплекты в области поиска, содержащие ссылки.

При переключении между типами отчета проверьте правильность значений в регулярных выражениях Ссылки на и Подходящие комплекты. Если в одном параметре применяется выражение с символом подстановки, например .*, то при переключении на другой тип отчета часто требуется перенести символ подстановки в другой параметр, чтобы получить наиболее полезный отчет.

Отчет об упоминаемых комплектах (Источники)
Отчет > Сообщить расположение вывода Позволяет указать абсолютный путь для размещения всех созданных отчетов. Пустое значение
Отчет > Обзор... Позволяет выбрать расположение для вывода отчетов.  
Отчет > Очистить каталог отчетов перед созданием отчета о новых результатах Позволяет очистить существующее расположение отчетов XML перед выполнением поиска с созданием отчета о результатах. Необходимо отметить, что эта опция полностью удалит указанный каталог отчетов, если он существует, вместе со всеми его дочерними каталогами. Не отмечена
Отчет > Создать отчеты HTML Преобразует весь вывод XML в отформатированный HTML и помещает его в каталог <расположение отчетов>\html Не отмечена
Отчет > Очистить расположение отчетов HTML Позволяет очистить существующее расположение отчетов HTML перед созданием новых отчетов. Необходимо отметить, что эта опция полностью удалит указанный каталог отчетов HTML, если он существует, вместе со всеми его дочерними каталогами. Эта опция может быть выбрана только вместе с указанной выше опцией Создать отчеты HTML. Не отмечена
Отчет > Открыть отчет по окончании поиска Открывает отчет HTML по окончании анализа. Эта опция может быть выбрана только вместе с указанной выше опцией Создать отчеты HTML. Не отмечена
Отчет > Описание Позволяет ввести удобочитаемое описание отчета. Пустое значение

Вкладка Шаблоны

Вкладка Шаблоны позволяет создавать различные шаблоны регулярного выражения для управления анализом использования. В настоящее время поддерживаются шаблоны трех видов:

  1. Шаблон архивов - позволяет указать вложенные архивы, которые должны игнорироваться во время анализа.
  2. Шаблон пакетов - позволяет указать пакеты, которые должны быть API или внутренними пакетами, без необходимости обновлять манифест комплекта.
  3. Шаблон преобразования отчетов - позволяет создать регулярное выражение имени пакета для фильтрации ссылок, включенных в отчет. Все ссылки, включенные в отчет, отфильтровываются по их полному имени пакета.

Вкладка Шаблоны


Опция

Описание

По умолчанию

Добавить... Позволяет добавить новый шаблон. Эта кнопка запустит мастер шаблонов.  
Изменить Позволяет изменить текущий выбранный шаблон. Одновременно можно изменять только один шаблон.  
Удалить Позволяет удалить выбранный шаблон или шаблоны. Одновременно можно удалить несколько шаблонов.  

Связанные задачи

Сравнение с контрольной версией API
Настройка контрольной версии

Связанные справочники Связанные справочники

Параметры контрольной версии API
Использование API - Мастер шаблонов