Документация класса

java.lang.Object
- com.sun.javadoc.Doclet

@Deprecated(since="9",
            forRemoval=true)
public abstract class Doclet
extends Object

Устаревший, подлежит удалению: Этот элемент API может быть удален в будущей версии.

Декларации в этом пакете были заменены декларациями в пакете jdk.javadoc.doclet. Дополнительную информацию можно найти в руководстве по миграции в документации по этому пакету.

Это пример начального класса для doclet, демонстрирующего методы точки входа. Начальный класс должен импортировать com.sun.javadoc.* и реализовывать метод start(RootDoc), как описано в описании пакета. Если doclet принимает параметры командной строки, он также должен реализовывать optionLength и validOptions.

Doclet, поддерживающий языковые возможности, добавленные после версии 1.1 (такие как дженерики и аннотации), должен указывать это, реализуя languageVersion. В противном случае doclet не должен вызывать методы API Doclet, добавленные после версии 1.5, и результаты нескольких других методов изменены таким образом, чтобы скрыть новые конструкции (например, параметры типа) от doclet.

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

Конструкторы

Конструктор	Описание
`Doclet()`	Устаревший, подлежит удалению: Этот элемент API может быть удален в будущей версии.

Методы

Модификатор и тип	Метод	Описание
`static LanguageVersion`	`languageVersion()`	Устаревший, подлежит удалению: Этот элемент API может быть удален в будущей версии. Возвращает версию языка программирования Java, поддерживаемую этим doclet.
`static int`	`optionLength(String option)`	Устаревший, подлежит удалению: Этот элемент API может быть удален в будущей версии. Проверка на наличие параметров, добавленных doclet.
`static boolean`	`start(RootDoc root)`	Устаревший, подлежит удалению: Этот элемент API может быть удален в будущей версии. Генерация документации здесь.
`static boolean`	`validOptions(String[][] options, DocErrorReporter reporter)`	Устаревший, подлежит удалению: Этот элемент API может быть удален в будущей версии. Проверка правильности аргументов параметров.

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

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

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

Doclet

public Doclet()

Устаревший, подлежит удалению: Этот элемент API может быть удален в будущей версии.

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

start

public static boolean start(RootDoc root)

Устаревший, подлежит удалению: Этот элемент API может быть удален в будущей версии.

Генерация документации здесь. Этот метод обязателен для всех doclet.

Параметры:: root - Предоставьте RootDoc методу.
Возвращает:: true при успехе.

optionLength

public static int optionLength(String option)

Устаревший, подлежит удалению: Этот элемент API может быть удален в будущей версии.

Проверка на наличие параметров, добавленных doclet. Возвращает количество аргументов, которые необходимо указать в командной строке для данного параметра. Например, "-d docs" вернёт 2.

Этот метод обязателен, если doclet содержит параметры. Если этот метод отсутствует, Javadoc выведет ошибку невалидного флага для каждого параметра.

Параметры:: option - параметр, для которого возвращается количество аргументов.
Возвращает:: количество аргументов в командной строке для параметра, включая сам параметр. Значение 0 означает, что параметр неизвестен. Отрицательное значение означает, что произошла ошибка.

validOptions

public static boolean validOptions(String[][] options,
                                   DocErrorReporter reporter)

Устаревший, подлежит удалению: Этот элемент API может быть удален в будущей версии.

Проверка правильности аргументов параметров.

Этот метод не является обязательным, но рекомендуется, так как каждый параметр будет считаться допустимым, если этот метод отсутствует. Он будет работать по умолчанию (вернёт true), если отсутствует.

Вывод сообщений об ошибках, связанных с параметрами (с использованием предоставленного DocErrorReporter), является задачей этого метода.

Параметры:: options - Допустимые параметры в виде массива строк.; reporter - DocErrorReporter, отвечающий за эти параметры.
Возвращает:: true, если параметры допустимы.

languageVersion

public static LanguageVersion languageVersion()

Устаревший, подлежит удалению: Этот элемент API может быть удален в будущей версии.

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

Этот метод необходим любому doclet, поддерживающему версию языка, более новую, чем 1.1.

Возвращает:: версия языка, поддерживаемая этим doclet.
Since:: 1.5