Interface InheritDocTree
- All Superinterfaces:
DocTree
,InlineTagTree
A tree node for an
@inheritDoc
inline tag.
{@inheritDoc} {@inheritDoc supertype}
- API Note:
- There is no requirement that the comment containing the tag and the comment containing the inherited documentation should either be both Markdown comments or both traditional (not Markdown) comments.
- Since:
- 1.8
-
Nested Class Summary
Nested classes/interfaces declared in interface com.sun.source.doctree.DocTree
DocTree.Kind
-
Method Summary
Modifier and TypeMethodDescriptiondefault ReferenceTree
Returns the reference to a superclass or superinterface from which to inherit documentation, ornull
if no reference was provided.Methods declared in interface com.sun.source.doctree.InlineTagTree
getTagName
-
Method Details
-
getSupertype
Returns the reference to a superclass or superinterface from which to inherit documentation, ornull
if no reference was provided.- Implementation Requirements:
- this implementation returns
null
. - Returns:
- the reference to a superclass or superinterface from which
to inherit documentation, or
null
if no reference was provided - Since:
- 22
-