Interface ParamTag

All Superinterfaces:
Tag
@Deprecated(since="9",
            forRemoval=true)
public interface ParamTag
extends Tag
Deprecated, for removal: This API element is subject to removal in a future version.
The declarations in this package have been superseded by those in the package jdk.javadoc.doclet. For more information, see the Migration Guide in the documentation for that package.

Represents an @param documentation tag. Stores the name and comment parts of the parameter tag. An @param tag may represent either a method or constructor parameter, or a type parameter.

Methods

Modifier and Type Method Description
boolean isTypeParameter()

Deprecated, for removal: This API element is subject to removal in a future version.

Return true if this ParamTag corresponds to a type parameter.
String parameterComment()

Deprecated, for removal: This API element is subject to removal in a future version.

Return the parameter comment associated with this ParamTag.
String parameterName()

Deprecated, for removal: This API element is subject to removal in a future version.

Return the name of the parameter or type parameter associated with this ParamTag.

Methods declared in interface com.sun.javadoc.Tag

firstSentenceTags, holder, inlineTags, kind, name, position, text, toString

Methods

parameterName

String parameterName()
Deprecated, for removal: This API element is subject to removal in a future version.

Return the name of the parameter or type parameter associated with this ParamTag. The angle brackets delimiting a type parameter are not part of its name.

Returns:
the parameter name.

parameterComment

String parameterComment()
Deprecated, for removal: This API element is subject to removal in a future version.

Return the parameter comment associated with this ParamTag.

Returns:
the parameter comment.

isTypeParameter

boolean isTypeParameter()
Deprecated, for removal: This API element is subject to removal in a future version.

Return true if this ParamTag corresponds to a type parameter. Return false if it corresponds to an ordinary parameter of a method or constructor.

Returns:
true if this ParamTag corresponds to a type parameter.
Since:
1.5

© 1993, 2020, 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/11/docs/api/jdk.javadoc/com/sun/javadoc/ParamTag.html