Класс StandardDoclet

java.lang.Object

jdk.javadoc.doclet.StandardDoclet

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

public class StandardDoclet extends Object implements Doclet

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

Пользовательские теглеты

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

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

С:

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

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

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

Doclet.Option

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

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

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

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

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

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

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

StandardDoclet

public StandardDoclet()

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