Класс 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

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

Конструктор	Описание
`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

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

StandardDoclet

public StandardDoclet()

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