Class StandardDoclet

java.lang.Object

jdk.javadoc.doclet.StandardDoclet

Все реализуемые интерфейсы:: Doclet

public class StandardDoclet extends Object implements Doclet

Этот доклет создает документацию в формате HTML для указанных модулей, пакетов и типов. Этот доклет используется инструментом javadoc и системным инструментом документирования, если не указан другой доклет.

Теглеты, определяемые пользователем

Стандартный доклет поддерживает определяемые пользователем taglets, которые можно использовать для создания пользовательского вывода для определяемых пользователем тегов в комментариях документации. Теглеты, вызываемые стандартным доклетом, должны возвращать строки из Taglet.toString следующим образом:

Встроенные теги: Возвращаемая строка должна представлять собой потоковое содержимое или допустимый фрагмент HTML-кода, который может находиться в теле документа. Могут применяться дополнительные ограничения в зависимости от того, как тег используется в комментарии документации: например, если тег можно использовать внутри встроенного элемента, такого как <b> или <i>, теглет не должен возвращать строку, содержащую блочные теги, такие как <h3> или <p>.
Блочные теги: Возвращаемая строка должна быть содержимым, подходящим для списка определений или элемента <dl>. Обычно это последовательность пар элементов <dt> и <dd>.

Начиная с:

Внешние спецификации

Краткое описание вложенных классов

Вложенные классы/интерфейсы, объявленные в интерфейсе Doclet

Doclet.Option

Модификатор и тип	Интерфейс	Описание
`static interface`	`Doclet.Option`	Инкапсуляция имени параметра, псевдонимов, параметров и описаний, используемых доклетом.

Краткое описание конструкторов

Конструктор	Описание
`StandardDoclet()`	Создает экземпляр стандартного доклета, используемого для создания документации в формате HTML.

Краткое описание методов

Модификатор и тип	Метод	Описание
`Locale`	`getLocale()`	Возвращает локаль для этого доклета.
`String`	`getName()`	Возвращает имя, идентифицирующее доклет.
`Reporter`	`getReporter()`	Возвращает средство отчетности для этого доклета.
`Set<? extends Doclet.Option>`	`getSupportedOptions()`	Возвращает все поддерживаемые параметры.
`SourceVersion`	`getSupportedSourceVersion()`	Возвращает версию языка программирования Java, поддерживаемую этим доклетом.
`void`	`init(Locale locale, Reporter reporter)`	Инициализирует этот доклет заданными локалью и средством отчетности об ошибках.
`boolean`	`run(DocletEnvironment docEnv)`	Точка входа доклета.

Методы, объявленные в классе Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Модификатор и тип	Метод	Описание
`protected Object`	`clone()`	Создает и возвращает копию этого объекта.
`boolean`	`equals(Object obj)`	Указывает, равен ли этот объект какому-либо другому объекту.
`protected void`	`finalize()`	Устарело, будет удалено: этот элемент API подлежит удалению в будущей версии. Финализация объявлена устаревшей и подлежит удалению в одном из будущих выпусков.
`final Class<?>`	`getClass()`	Возвращает класс времени выполнения этого `Object`.
`int`	`hashCode()`	Возвращает хеш-код этого объекта.
`final void`	`notify()`	Пробуждает один поток, ожидающий на мониторе этого объекта.
`final void`	`notifyAll()`	Пробуждает все потоки, ожидающие на мониторе этого объекта.
`String`	`toString()`	Возвращает строковое представление объекта.
`final void`	`wait()`	Переводит текущий поток в состояние ожидания до его пробуждения, обычно в результате уведомления или прерывания.
`final void`	`wait(long timeoutMillis)`	Переводит текущий поток в состояние ожидания до его пробуждения, обычно в результате уведомления или прерывания, либо до истечения заданного периода реального времени.
`final void`	`wait(long timeoutMillis, int nanos)`	Переводит текущий поток в состояние ожидания до его пробуждения, обычно в результате уведомления или прерывания, либо до истечения заданного периода реального времени.

Подробное описание конструкторов

StandardDoclet

public StandardDoclet()

Создает экземпляр стандартного доклета, используемого для создания документации в формате HTML.