Интерфейс Doclet

Все известные классы, реализующие интерфейс:: StandardDoclet

public interface Doclet

Пользовательский doclet должен реализовывать этот интерфейс, как описано в описании пакета. Каждая реализация Doclet должна предоставлять открытый конструктор без аргументов, который инструменты будут использовать для создания экземпляра doclet. Инфраструктура инструмента взаимодействует с классами, реализующими этот интерфейс, следующим образом:

Инструмент создает экземпляр doclet с помощью конструктора без аргументов класса doclet.
Затем инструмент вызывает метод init с соответствующей локалью и объектом средства формирования отчетов.
После этого инструмент вызывает методы getSupportedOptions и getSupportedSourceVersion. Эти методы вызываются только один раз.
При необходимости инструмент вызывает метод run объекта doclet, передавая ему объект DocletEnvironment, из которого doclet может определить элементы, которые следует включить в документацию.

Если объект doclet создан и используется без соблюдения описанного выше протокола, поведение doclet не определяется спецификацией этого интерфейса.

Чтобы запустить doclet, передайте -doclet, а затем полное имя класса точки входа (то есть реализации этого интерфейса) в командной строке инструмента javadoc.

С версии:: 9

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

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

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

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

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

init

void init(Locale locale, Reporter reporter)

Инициализирует этот doclet с указанными локалью и средством формирования отчетов об ошибках. Эта локаль будет использоваться средством формирования отчетов и компонентами doclet.

Параметры:: locale — используемая локаль; reporter — используемое средство формирования отчетов

getName

String getName()

Возвращает имя, идентифицирующее doclet. Имя представляет собой простой идентификатор без пробелов, определенный в Спецификации языка Java, раздел 6.2 «Имена и идентификаторы».

Возвращает:: имя Doclet

getSupportedOptions

Set<? extends Doclet.Option> getSupportedOptions()

Возвращает все поддерживаемые параметры.

Возвращает:: набор, содержащий все поддерживаемые параметры; пустой набор, если таких параметров нет

getSupportedSourceVersion

SourceVersion getSupportedSourceVersion()

Возвращает версию языка программирования Java, поддерживаемую этим doclet.

Возвращает:: версия языка, поддерживаемая этим doclet; обычно последняя версия

run

boolean run(DocletEnvironment environment)

Точка входа doclet. Дальнейшая обработка выполняется в соответствии с указаниями этого метода.

Параметры:: environment — объект, из которого можно извлечь необходимые сведения
Возвращает:: true в случае успеха

© 1993, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/25/docs/api/jdk.javadoc/jdk/javadoc/doclet/Doclet.html