Modifier and Type	Class and Description
private static record	InheritDocTaglet.Documentation

Access	Constructor and Description
pack-priv	InheritDocTaglet(HtmlConfiguration config) Construct a new InheritDocTaglet.

Method Summary

Modifier and Type	Method and Description
private static DocFinder.Result<InheritDocTaglet.Documentation>	extractMainDescription(ExecutableElement m, boolean extractFirstSentenceOnly, Utils utils)
public Content	getInlineTagOutput(Element e, DocTree inheritDoc, TagletWriter tagletWriter) Overrides jdk.javadoc.internal.doclets.formats.html.taglets.BaseTaglet.getInlineTagOutput. Implements jdk.javadoc.internal.doclets.formats.html.taglets.Taglet.getInlineTagOutput. Returns the content to be included in the generated output for an instance of an inline tag handled by this taglet.
private Content	retrieveInheritedDocumentation(TagletWriter the writer that is writing the output. writer, ExecutableElement the method that we are documenting. method, InheritDocTree the `{@inheritDoc}` tag inheritDoc, boolean true if we only want to inherit the first sentence isFirstSentence) Given an element and `@inheritDoc` tag in that element's doc comment, returns the (recursive) expansion of that tag.

Inherited from jdk.javadoc.internal.doclets.formats.html.taglets.BaseTaglet:: getAllBlockTagOutput getAllowedLocations getName getTagKind isInlineTag

InheritDocTaglet	back to summary
pack-priv InheritDocTaglet(HtmlConfiguration config) Construct a new InheritDocTaglet.

Method Detail

extractMainDescription	back to summary
private static DocFinder.Result<InheritDocTaglet.Documentation> extractMainDescription(ExecutableElement m, boolean extractFirstSentenceOnly, Utils utils)

getInlineTagOutput	back to summary
public Content getInlineTagOutput(Element e, DocTree inheritDoc, TagletWriter tagletWriter) Overrides jdk.javadoc.internal.doclets.formats.html.taglets.BaseTaglet.getInlineTagOutput. Implements jdk.javadoc.internal.doclets.formats.html.taglets.Taglet.getInlineTagOutput. Doc from jdk.javadoc.internal.doclets.formats.html.taglets.BaseTaglet.getInlineTagOutput. Returns the content to be included in the generated output for an instance of an inline tag handled by this taglet. Annotations @Override

getInlineTagOutput

back to summary

public Content getInlineTagOutput(Element e, DocTree inheritDoc, TagletWriter tagletWriter)

Overrides jdk.javadoc.internal.doclets.formats.html.taglets.BaseTaglet.getInlineTagOutput.

Implements jdk.javadoc.internal.doclets.formats.html.taglets.Taglet.getInlineTagOutput.

Doc from jdk.javadoc.internal.doclets.formats.html.taglets.BaseTaglet.getInlineTagOutput.

Returns the content to be included in the generated output for an instance of an inline tag handled by this taglet.

Annotations

@Override

retrieveInheritedDocumentation back to summary

retrieveInheritedDocumentation	back to summary
private Content retrieveInheritedDocumentation(TagletWriter writer, ExecutableElement method, InheritDocTree inheritDoc, boolean isFirstSentence) Given an element and `@inheritDoc` tag in that element's doc comment, returns the (recursive) expansion of that tag. This method does not expand all `{@inheritDoc}` tags in the given element's doc comment. To do this, the method must be called for every such tag. Parameters writer:TagletWriter the writer that is writing the output. method:ExecutableElement the method that we are documenting. inheritDoc:InheritDocTree the `{@inheritDoc}` tag isFirstSentence:boolean true if we only want to inherit the first sentence

private Content retrieveInheritedDocumentation(TagletWriter writer, ExecutableElement method, InheritDocTree inheritDoc, boolean isFirstSentence)

Given an element and @inheritDoc tag in that element's doc comment, returns the (recursive) expansion of that tag.

This method does not expand all {@inheritDoc} tags in the given element's doc comment. To do this, the method must be called for every such tag.

Parameters

writer:TagletWriter: the writer that is writing the output.
method:ExecutableElement: the method that we are documenting.
inheritDoc:InheritDocTree: the {@inheritDoc} tag
isFirstSentence:boolean: true if we only want to inherit the first sentence

jdk.javadoc.internal.doclets.formats.html.taglets back to summary

private final Record InheritDocTaglet.Documentation

Class Inheritance

extends Record

java.lang.Object
java.lang.Record
jdk.javadoc.internal.doclets.formats.html.taglets.InheritDocTaglet.Documentation

Record Components

mainDescription:List<? extends DocTree>
method:ExecutableElement

Field Summary

Modifier and Type	Field and Description
private final List<? extends DocTree>	mainDescription Record Component accessed by mainDescription().
private final ExecutableElement	method Record Component accessed by method().

Constructor Summary

Access	Constructor and Description
private	Documentation(List<? extends DocTree> mainDescription, ExecutableElement method)

Method Summary

Modifier and Type	Method and Description
public final boolean	equals(Object o) Implements abstract java.lang.Record.equals. Indicates whether some other object is "equal to" this one.
public final int	hashCode() Implements abstract java.lang.Record.hashCode. Returns a hash code value for the record.
public List<? extends DocTree>	mainDescription() Record Component getter of mainDescription.
public ExecutableElement	method() Record Component getter of method.
public final String	toString() Implements abstract java.lang.Record.toString. Returns a string representation of the record.

Field Detail

mainDescription	back to summary
private final List<? extends DocTree> mainDescription Record Component accessed by mainDescription().

method	back to summary
private final ExecutableElement method Record Component accessed by method().

Constructor Detail

Documentation	back to summary
private Documentation(List<? extends DocTree> mainDescription, ExecutableElement method)

Method Detail

equals back to summary

equals	back to summary
public final boolean equals(Object o) Implements abstract java.lang.Record.equals. Doc from java.lang.Record.equals. Indicates whether some other object is "equal to" this one. In addition to the general contract of `Object.equals`, record classes must further obey the invariant that when a record instance is "copied" by passing the result of the record component accessor methods to the canonical constructor, as follows: R copy = new R(r.c1(), r.c2(), ..., r.cn()); then it must be the case that `r.equals(copy)`.

public final boolean equals(Object o)

Implements abstract java.lang.Record.equals.

Doc from java.lang.Record.equals.

Indicates whether some other object is "equal to" this one. In addition to the general contract of Object.equals, record classes must further obey the invariant that when a record instance is "copied" by passing the result of the record component accessor methods to the canonical constructor, as follows:

    R copy = new R(r.c1(), r.c2(), ..., r.cn());

then it must be the case that r.equals(copy).

hashCode back to summary

hashCode	back to summary
public final int hashCode() Implements abstract java.lang.Record.hashCode. Doc from java.lang.Record.hashCode. Returns a hash code value for the record. Obeys the general contract of `Object.hashCode`. For records, hashing behavior is constrained by the refined contract of `Record.equals`, so that any two records created from the same components must have the same hash code.

public final int hashCode()

Implements abstract java.lang.Record.hashCode.

Doc from java.lang.Record.hashCode.

Returns a hash code value for the record. Obeys the general contract of Object.hashCode. For records, hashing behavior is constrained by the refined contract of Record.equals, so that any two records created from the same components must have the same hash code.

mainDescription	back to summary
public List<? extends DocTree> mainDescription() Record Component getter of mainDescription.

method	back to summary
public ExecutableElement method() Record Component getter of method.

toString back to summary

toString	back to summary
public final String toString() Implements abstract java.lang.Record.toString. Doc from java.lang.Record.toString. Returns a string representation of the record. In accordance with the general contract of `Object#toString()`, the `toString` method returns a string that "textually represents" this record. The result should be a concise but informative representation that is easy for a person to read. In addition to this general contract, record classes must further participate in the invariant that any two records which are equal must produce equal strings. This invariant is necessarily relaxed in the rare case where corresponding equal component values might fail to produce equal strings for themselves.

public final String toString()

Implements abstract java.lang.Record.toString.

Doc from java.lang.Record.toString.

Returns a string representation of the record. In accordance with the general contract of Object#toString(), the toString method returns a string that "textually represents" this record. The result should be a concise but informative representation that is easy for a person to read.

In addition to this general contract, record classes must further participate in the invariant that any two records which are equal must produce equal strings. This invariant is necessarily relaxed in the rare case where corresponding equal component values might fail to produce equal strings for themselves.

public Class InheritDocTaglet

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail

private final Record InheritDocTaglet.Documentation

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail