Класс StandardDoclet

java.lang.Object

jdk.javadoc.doclet.StandardDoclet

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

public class StandardDoclet extends Object implements Doclet

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

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

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

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

См. также:

Спецификация комментариев к документации для стандартного doclet

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

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

Doclet.Option

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

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

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

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

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

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

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

StandardDoclet

public StandardDoclet()

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