FileDocCategorySizeDatePackage
ParamTag.javaAPI DocJava SE 5 API1285Fri Aug 26 14:54:54 BST 2005com.sun.javadoc

ParamTag

public interface ParamTag implements Tag
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.
author
Robert Field

Fields Summary
Constructors Summary
Methods Summary
public booleanisTypeParameter()
Return true if this ParamTag corresponds to a type parameter. Return false if it corresponds to an ordinary parameter of a method or constructor.

return
true if this ParamTag corresponds to a type parameter.
since
1.5

public java.lang.StringparameterComment()
Return the parameter comment associated with this ParamTag.

return
the parameter comment.

public java.lang.StringparameterName()
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.

return
the parameter name.