com.sun.source.doctree

public Interface InheritDocTree

Known Direct Implementers: com.sun.tools.javac.tree.DCTree.DCInheritDoc

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

Method Summary

Modifier and Type	Method and Description
public default ReferenceTree	Returns: the reference to a superclass or superinterface from which to inherit documentation, or `null` if no reference was provided getSupertype() Returns the reference to a superclass or superinterface from which to inherit documentation, or `null` if no reference was provided.

Inherited from com.sun.source.doctree.InlineTagTree:: getTagName

Method Detail

getSupertype back to summary

getSupertype	back to summary
public default ReferenceTree getSupertype() Returns the reference to a superclass or superinterface from which to inherit documentation, or `null` if no reference was provided. Implementation Specification this implementation returns `null`. Returns:ReferenceTree the reference to a superclass or superinterface from which to inherit documentation, or `null` if no reference was provided Since 22

public default ReferenceTree getSupertype()

Returns the reference to a superclass or superinterface from which to inherit documentation, or null if no reference was provided.

Implementation Specification

this implementation returns null.

Returns:ReferenceTree: the reference to a superclass or superinterface from which to inherit documentation, or null if no reference was provided
Since: 22