Использование API - Мастер шаблонов

Этот мастер поможет вам в создании шаблонов регулярных выражений, предназначенных для управления анализом использования API.

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

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

Опция

Описание

По умолчанию

Типы шаблонов В этом списке перечислены все шаблоны, которые можно создать с помощью мастера. Первый элемент списка
Описание Удобочитаемое описание вида шаблона, выбранного в списке Типы шаблонов.  

Первая страница мастера позволяет выбрать вид шаблона для создания. Каждый шаблон снабжен описанием для удобства выбора - просто щелкните на шаблоне, и описание появится в поле Описание.

Мастер
шаблонов использования API - страница выбора шаблона

Шаблоны архивов

Во время анализа использования API просматриваются все папки и архивы комплекта; это гарантирует, что будут проанализированы все файлы классов. В некоторых случаях комплект может содержать архив со старыми версиями файлов классов (например), которые вы не хотите анализировать. В этом случае шаблон архивов позволяет настроить полное игнорирование конкретного архива или всех архивов, соответствующих заданному регулярному выражению.

Опция

Описание

По умолчанию

Имя комплекта Полное символьное имя комплекта, к которому применяется этот шаблон. Например: org.eclipse.pde.api.tools. Пустое значение
Имя архива Полное имя или регулярное выражение архива (или архивов), к которому применяется шаблон. Например, *.jar означает, что будут игнорироваться все вложенные файлы jar. Пустое значение

Мастер
шаблонов использования API - создание шаблонов архивов

Шаблоны пакетов

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

Опция

Описание

По умолчанию

Шаблон Шаблон регулярного выражения, с которым следует сравнивать пакеты. Например: .*\.internal\..*. Пустое значение
Шаблон API Указывает, следует ли рассматривать подходящие пакеты как API или нет. Отмечена

Мастер
шаблонов использования API - создание шаблонов пакетов

Шаблоны преобразования отчетов

По окончании анализа использования API может остаться значительный объем информации для просмотра. Шаблон преобразования отчетов позволяет убрать часть информации о ссылках, представленной в отчетах HTML, оставив лишь то, что вас интересует. Для этого можно создать шаблоны исключения, предназначенные для удаления ненужных ссылок из отчета.

Опция

Описание

По умолчанию

Отфильтровать ссылки на этот шаблон Позволяет игнорировать ссылки, соответствующие данному шаблону, при составлении отчета. Например, в случае шаблона org\.eclipse\.jdt\..* выбор этой опции исключает из отчета все ссылки на JDT. Выбрана
Отфильтровать ссылки из этого шаблона Позволяет игнорировать ссылки, соответствующие данному шаблону, при составлении отчета. Например, в случае шаблона org\.eclipse\.jdt\..* выбор этой опции исключает из отчета все ссылки из JDT.  
Шаблон Шаблон регулярного выражения. Пустое значение

Мастер
шаблонов использования API - создание шаблонов преобразования
отчетов

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

Настройка инструментов API

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

Действие настройки инструментов API
Меню инструментов PDE
Отчеты об использовании API