Интерфейс RootDoc

Все суперинтерфейсы:: Comparable<Object>, Doc, DocErrorReporter

@Deprecated(since="9",
            forRemoval=true)
public interface RootDoc
extends Doc, DocErrorReporter

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

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

Представляет корень информации о структуре программы для одного запуска javadoc. Из этого корня можно извлечь всю остальную информацию о структуре программы. Также представляет информацию командной строки — пакеты, классы и опции, указанные пользователем.

С момента:: 1.2

Методы

Модификатор и тип	Метод	Описание
`ClassDoc[]`	`classes()`	Устаревшее, подлежит удалению: Этот элемент API может быть удален в будущей версии. Возвращает классы и интерфейсы, включённые во всех пакетах.
`ClassDoc`	`classNamed(String qualifiedName)`	Устаревшее, подлежит удалению: Этот элемент API может быть удален в будущей версии. Возвращает ClassDoc для указанного класса или интерфейса.
`String[][]`	`options()`	Устаревшее, подлежит удалению: Этот элемент API может быть удален в будущей версии. Параметры командной строки.
`PackageDoc`	`packageNamed(String name)`	Устаревшее, подлежит удалению: Этот элемент API может быть удален в будущей версии. Возвращает PackageDoc для указанного имени пакета.
`ClassDoc[]`	`specifiedClasses()`	Устаревшее, подлежит удалению: Этот элемент API может быть удален в будущей версии. Возвращает классы и интерфейсы, указанные в качестве имён файлов исходного кода в командной строке.
`PackageDoc[]`	`specifiedPackages()`	Устаревшее, подлежит удалению: Этот элемент API может быть удален в будущей версии. Возвращает пакеты указанные в командной строке.

Методы, объявленные в интерфейсе com.sun.javadoc.Doc

commentText, compareTo, firstSentenceTags, getRawCommentText, inlineTags, isAnnotationType, isAnnotationTypeElement, isClass, isConstructor, isEnum, isEnumConstant, isError, isException, isField, isIncluded, isInterface, isMethod, isOrdinaryClass, name, position, seeTags, setRawCommentText, tags, tags

Методы, объявленные в интерфейсе com.sun.javadoc.DocErrorReporter

printError, printError, printNotice, printNotice, printWarning, printWarning

Методы

options

String[][] options()

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

Параметры командной строки.

Например, приведённом:

javadoc -foo this that -bar other ...

этот метод вернёт:

options()[0][0] = "-foo"
      options()[0][1] = "this"
      options()[0][2] = "that"
      options()[1][0] = "-bar"
      options()[1][1] = "other"

Возвращает:: массив массивов строк.

specifiedPackages

PackageDoc[] specifiedPackages()

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

Возвращает пакеты указанные в командной строке. Если используются параметры -subpackages и -exclude, возвращает все пакеты, не исключённые из списка.

Возвращает:: пакеты, указанные в командной строке.

specifiedClasses

ClassDoc[] specifiedClasses()

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

Возвращает классы и интерфейсы указанные в качестве имён файлов исходного кода в командной строке.

Возвращает:: классы и интерфейсы, указанные в командной строке.

classes

ClassDoc[] classes()

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

Возвращает включённые классы и интерфейсы во всех пакетах.

Возвращает:: включённые классы и интерфейсы во всех пакетах.

packageNamed

PackageDoc packageNamed(String name)

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

Возвращает PackageDoc для указанного имени пакета.

Параметры:: name - имя пакета
Возвращает:: PackageDoc, содержащий указанный пакет, null, если этот пакет не указан.

classNamed

ClassDoc classNamed(String qualifiedName)

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

Возвращает ClassDoc для указанного имени класса или интерфейса.

Параметры:: qualifiedName - полное имя класса или пакета
Возвращает:: ClassDoc, содержащий указанный класс, null, если этот класс не указан.