Modifier and Type	Class and Description
private static record	ParamTaglet.Documentation
public static enum	ParamTaglet.ParamKind

Modifier and Type	Field and Description
private final Contents	contents

Access	Constructor and Description
pack-priv	ParamTaglet(HtmlConfiguration config)

Method Summary

Modifier and Type	Method and Description
private Content	convertParam(Element e, ParamTaglet.ParamKind kind, TagletWriter writer, ParamTree paramTag, String name, boolean isFirstParam) Converts an individual `ParamTree` to `Content`, which is prepended with the header if the parameter is first in the list.
private Content	convertParams(Element e, ParamTaglet.ParamKind the kind of all parameters in the lists kind, List<ParamTree> tags, List<? extends Element> parameters, TagletWriter writer) Returns a `Content` representation of a list of `ParamTree` of the specified kind.
private static Optional<ParamTaglet.Documentation>	extract(Utils utils, ExecutableElement method, Integer position, boolean typeParam)
public Content	getAllBlockTagOutput(Element holder, TagletWriter tagletWriter) Overrides jdk.javadoc.internal.doclets.formats.html.taglets.BaseTaglet.getAllBlockTagOutput. Implements jdk.javadoc.internal.doclets.formats.html.taglets.Taglet.getAllBlockTagOutput. Returns the content to be included in the generated output for all instances of block tags handled by this taglet.
private Content	getInheritedTagletOutput(ParamTaglet.ParamKind kind, Element holder, TagletWriter writer, Element param, int position, boolean isFirst) Tries to inherit documentation for a specific parameter (element).
private Content	getParamHeader(ParamTaglet.ParamKind kind)
public InheritableTaglet.Output	inherit(Element dst, Element src, DocTree tag, boolean isFirstSentence) Implements jdk.javadoc.internal.doclets.formats.html.taglets.InheritableTaglet.inherit.
private static Map<String, Integer>	Returns: a name-position map mapNameToPosition(Utils utils, List<? extends Element> the list of parameters from a type or an executable member params) Given a list of parameter elements, returns a name-position map.
private Content	paramTagOutput(Element element, ParamTree paramTag, String paramName)

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

Field Detail

contents	back to summary
private final Contents contents

ParamTaglet	back to summary
pack-priv ParamTaglet(HtmlConfiguration config)

Method Detail

convertParam	back to summary
private Content convertParam(Element e, ParamTaglet.ParamKind kind, TagletWriter writer, ParamTree paramTag, String name, boolean isFirstParam) Converts an individual `ParamTree` to `Content`, which is prepended with the header if the parameter is first in the list.

convertParams back to summary

convertParams	back to summary
private Content convertParams(Element e, ParamTaglet.ParamKind kind, List<ParamTree> tags, List<? extends Element> parameters, TagletWriter writer) Returns a `Content` representation of a list of `ParamTree` of the specified kind. This method correlates a `ParamTree` with a parameter `Element` by name. Once it's done, a particular `ParamTree` is addressed by the position (index) of the correlated `Element` in the list of parameter elements. This is needed for documentation inheritance because the corresponding parameters in the inheritance hierarchy may be named differently. This method warns about `@param` tags that do not map to parameter elements and param tags that are duplicated. Parameters kind:ParamTaglet.ParamKind the kind of all parameters in the lists

private Content convertParams(Element e, ParamTaglet.ParamKind kind, List<ParamTree> tags, List<? extends Element> parameters, TagletWriter writer)

Returns a Content representation of a list of ParamTree of the specified kind.

This method correlates a ParamTree with a parameter Element by name. Once it's done, a particular ParamTree is addressed by the position (index) of the correlated Element in the list of parameter elements. This is needed for documentation inheritance because the corresponding parameters in the inheritance hierarchy may be named differently.

This method warns about @param tags that do not map to parameter elements and param tags that are duplicated.

Parameters

kind:ParamTaglet.ParamKind: the kind of all parameters in the lists

extract	back to summary
private static Optional<ParamTaglet.Documentation> extract(Utils utils, ExecutableElement method, Integer position, boolean typeParam)

getAllBlockTagOutput	back to summary
public Content getAllBlockTagOutput(Element holder, TagletWriter tagletWriter) Overrides jdk.javadoc.internal.doclets.formats.html.taglets.BaseTaglet.getAllBlockTagOutput. Implements jdk.javadoc.internal.doclets.formats.html.taglets.Taglet.getAllBlockTagOutput. Doc from jdk.javadoc.internal.doclets.formats.html.taglets.BaseTaglet.getAllBlockTagOutput. Returns the content to be included in the generated output for all instances of block tags handled by this taglet. Annotations @Override

getAllBlockTagOutput

back to summary

public Content getAllBlockTagOutput(Element holder, TagletWriter tagletWriter)

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

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

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

Returns the content to be included in the generated output for all instances of block tags handled by this taglet.

Annotations

@Override

getInheritedTagletOutput	back to summary
private Content getInheritedTagletOutput(ParamTaglet.ParamKind kind, Element holder, TagletWriter writer, Element param, int position, boolean isFirst) Tries to inherit documentation for a specific parameter (element). If unsuccessful, the returned content is empty.

getParamHeader	back to summary
private Content getParamHeader(ParamTaglet.ParamKind kind)

inherit	back to summary
public InheritableTaglet.Output inherit(Element dst, Element src, DocTree tag, boolean isFirstSentence) Implements jdk.javadoc.internal.doclets.formats.html.taglets.InheritableTaglet.inherit. Annotations @Override

inherit

back to summary

public InheritableTaglet.Output inherit(Element dst, Element src, DocTree tag, boolean isFirstSentence)

Implements jdk.javadoc.internal.doclets.formats.html.taglets.InheritableTaglet.inherit.

Annotations

@Override

mapNameToPosition	back to summary
private static Map<String, Integer> mapNameToPosition(Utils utils, List<? extends Element> params) Given a list of parameter elements, returns a name-position map. Parameters params:List<? extends Element> the list of parameters from a type or an executable member Returns:Map<String, Integer> a name-position map

mapNameToPosition

back to summary

private static Map<String, Integer> mapNameToPosition(Utils utils, List<? extends Element> params)

Given a list of parameter elements, returns a name-position map.

Parameters

params:List<? extends Element>: the list of parameters from a type or an executable member

Returns:Map<String, Integer>

a name-position map

paramTagOutput	back to summary
private Content paramTagOutput(Element element, ParamTree paramTag, String paramName)

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

private final Record ParamTaglet.Documentation

Class Inheritance

extends Record

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

Record Components

paramTree:ParamTree
method:ExecutableElement

Field Summary

Modifier and Type	Field and Description
private final ExecutableElement	method Record Component accessed by method().
private final ParamTree	paramTree Record Component accessed by paramTree().

Constructor Summary

Access	Constructor and Description
private	Documentation(ParamTree paramTree, 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 ExecutableElement	method() Record Component getter of method.
public ParamTree	paramTree() Record Component getter of paramTree.
public final String	toString() Implements abstract java.lang.Record.toString. Returns a string representation of the record.

Field Detail

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

paramTree	back to summary
private final ParamTree paramTree Record Component accessed by paramTree().

Constructor Detail

Documentation	back to summary
private Documentation(ParamTree paramTree, 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.

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

paramTree	back to summary
public ParamTree paramTree() Record Component getter of paramTree.

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.

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

public final Enum ParamTaglet.ParamKind

Class Inheritance

extends Enum<ParamTaglet.ParamKind>

java.lang.Object
java.lang.Enum
jdk.javadoc.internal.doclets.formats.html.taglets.ParamTaglet.ParamKind

Field Summary

Modifier and Type	Field and Description
public static final ParamTaglet.ParamKind	PARAMETER Parameter of an executable element.
public static final ParamTaglet.ParamKind	RECORD_COMPONENT State components of a record.
public static final ParamTaglet.ParamKind	TYPE_PARAMETER Type parameters of an executable element or type element.

Constructor Summary

Access	Constructor and Description
private	ParamKind()

Method Summary

Modifier and Type	Method and Description
public static ParamTaglet.ParamKind	valueOf(String name)
public static ParamTaglet.ParamKind[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

PARAMETER	back to summary
public static final ParamTaglet.ParamKind PARAMETER Parameter of an executable element.

RECORD_COMPONENT	back to summary
public static final ParamTaglet.ParamKind RECORD_COMPONENT State components of a record.

TYPE_PARAMETER	back to summary
public static final ParamTaglet.ParamKind TYPE_PARAMETER Type parameters of an executable element or type element.

Constructor Detail

ParamKind	back to summary
private ParamKind()

Method Detail

valueOf	back to summary
public static ParamTaglet.ParamKind valueOf(String name)

values	back to summary
public static ParamTaglet.ParamKind[] values()

public Class ParamTaglet

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Record ParamTaglet.Documentation

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum ParamTaglet.ParamKind

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail