Мастер
Генерация Javadoc предназначен для создания документации Javadoc. Он представляет собой
интерфейс инструмента javadoc.exe, входящего в состав Java JDK. Полная документация по инструменту javadoc приведена на странице
Sun's
Javadoc Tool.
Выбор типа:
Опция |
Описание |
---|---|
Выбрать типы, для которых будет создана документация по Java |
В списке поставьте или удалите отметки с переключателей, указав в точности те типы, которые нужно экспортировать в файл JAR. Этот список инициализируется при выборе рабочей среды. За один раз можно выбрать только один проект, поскольку при работе с инструментом Javadoc в каждый момент можно использовать только один путь к классам проекта. |
Создать документацию по Java для элементов с областью доступа: |
|
Применять стандартный доклет |
Запустить команду Javadoc со стандартным доклетом (значение по умолчанию)
|
Применять пользовательский доклет |
Применять пользовательский доклет для создания документации
|
Стандартные аргументы доклета (доступно, если выбрана опция Применять стандартный доклет):
Опция |
Описание |
---|---|
Заголовок документа |
Укажите заголовок документа. |
Создать страницу применения | Выберите эту опцию, если вы хотите, чтобы документация содержала страницу Применение. |
Создать дерево иерархии | Выберите эту опцию, если вы хотите, чтобы документация содержала страницу Дерево. |
Создать панель навигации |
Выберите эту опцию, если вы хотите, чтобы документация содержала панель навигации (верхний и нижний колонтитулы). |
Создать индекс | Выберите эту опцию, если вы хотите, чтобы документация содержала страницу Индекс. |
Создать индекс по буквам | Позволяет создать индекс по буквам. Доступна при выбранной опции Создать индекс. |
@author | Выберите эту опцию, если вы хотите, чтобы тег @author документировался. |
@version | Выберите эту опцию, если вы хотите, чтобы тег @version документировался. |
@deprecated | Выберите эту опцию, если вы хотите, чтобы тег @deprecated документировался. |
список устаревших | Выберите эту опцию, если вы хотите, чтобы документация содержала страницу Устаревшие. Доступна при выбранной опции @deprecated. |
Выбрать упоминаемые классы, на которые Javadoc должна создать ссылки |
Укажите, на какие разделы прочей документации должна создать ссылки
команда Javadoc, если упоминаются другие типы.
|
Лист стилей | Выберите лист стилей, который нужно применять |
Общие опции Javadoc:
Опция |
Описание |
---|---|
Обзор |
Указывает, что Javadoc должна извлекать текст обзорной документации из заданного файла. Текст будет помещен в overview-summary.html. |
Дополнительные опции Javadoc |
Добавить здесь произвольное число дополнительных опций: опции
пользовательских доклетов, опции VM или опции совместимости JRE 1.4. |
Сохранить параметры этого экспорта Javadoc в качестве сценария Ant |
Эта опция позволяет сохранить сценарий Ant, который будет выполнять указанный экспорт Javadoc без необходимости запускать мастер. Существующий сценарий Ant можно изменить с помощью этого мастера (в созданном сценарии Ant откройте контекстное меню и выберите Открыть документацию по Java) |
Открыть созданный файл индекса в браузере | Открывает созданный файл index.html в браузере (доступна только в случае стандартного доклета) |
Нажмите Готово, чтобы начать создание документации с помощью Javadoc. Если целевое расположение отличается от того, что указано на странице Расположение Javadoc проекта, то вам будет предложено подтвердить его. В случае утвердительного ответа, при всех запусках команды Открыть внешнюю Javadoc будет применяться вновь созданная документация.
Будет запущен новый процесс создания, который будет выполняться в фоновом режиме. Для просмотра информации о состоянии и ходе выполнения процесса создания откройте панель Консоль (Окно > Показать панель > Консоль).
Действия над файлами
Свойства
расположения документации по Java