Интерфейс DocCommentTree

Все суперинтерфейсы:: DocTree

public interface DocCommentTree extends DocTree

Представление документационного комментария верхнего уровня.

    first-sentence body block-tags

С:: 1.8

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

Вложенные классы/интерфейсы, объявленные в интерфейсе com.sun.source.doctree.DocTree

DocTree.Kind

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

Модификатор и тип	Метод	Описание
`List<? extends DocTree>`	`getBlockTags()`	Возвращает теги блоков для документационного комментария.
`List<? extends DocTree>`	`getBody()`	Возвращает тело документационного комментария, появляющееся после первого предложения и перед любыми тегами блоков.
`List<? extends DocTree>`	`getFirstSentence()`	Возвращает первое предложение документационного комментария.
`default List<? extends DocTree>`	`getFullBody()`	Возвращает все тело документационного комментария, появляющееся перед любыми тегами блоков, включая первое предложение.
`default List<? extends DocTree>`	`getPostamble()`	Возвращает список деревьев, содержащих содержимое (если есть) после содержимого документационного комментария.
`default List<? extends DocTree>`	`getPreamble()`	Возвращает список деревьев, содержащих содержимое (если есть) перед содержимым документационного комментария.

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

accept, getKind

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

getFirstSentence

List<? extends DocTree> getFirstSentence()

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

Возвращает:: первое предложение документационного комментария

getFullBody

default List<? extends DocTree> getFullBody()

Возвращает все тело документационного комментария, появляющееся перед любыми тегами блоков, включая первое предложение.

Возвращает:: тело документационного комментария, включая первое предложение
С:: 9

getBody

List<? extends DocTree> getBody()

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

Возвращает:: тело документационного комментария

getBlockTags

List<? extends DocTree> getBlockTags()

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

Возвращает:: теги блоков документационного комментария

getPreamble

default List<? extends DocTree> getPreamble()

Возвращает список деревьев, содержащих содержимое (если есть) перед содержимым документационного комментария. Когда DocCommentTree было прочитано из документационного комментария в файле исходного кода Java, список будет пустым. Когда DocCommentTree было прочитано из HTML-файла, это представляет содержимое с начала файла до и включая тег <body>.

Требования к реализации:: Эта реализация возвращает пустой список.
Возвращает:: список деревьев
С:: 10

getPostamble

default List<? extends DocTree> getPostamble()

Возвращает список деревьев, содержащих содержимое (если есть) после содержимого документационного комментария. Когда DocCommentTree было прочитано из документационного комментария в файле исходного кода Java, список будет пустым. Когда DocCommentTree было прочитано из HTML-файла, это представляет содержимое от тега </body> до конца файла.

Требования к реализации:: Эта реализация возвращает пустой список.
Возвращает:: список деревьев
С:: 10

© 1993, 2021, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/17/docs/api/jdk.compiler/com/sun/source/doctree/DocCommentTree.html