|
Doclet API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ParamTag
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.
Method Summary | |
---|---|
boolean |
isTypeParameter()
Return true if this ParamTag corresponds to a type
parameter. |
String |
parameterComment()
Return the parameter comment associated with this ParamTag . |
String |
parameterName()
Return the name of the parameter or type parameter associated with this ParamTag . |
Methods inherited from interface com.sun.javadoc.Tag |
---|
firstSentenceTags, holder, inlineTags, kind, name, position, text, toString |
Method Detail |
---|
String parameterName()
ParamTag
.
The angle brackets delimiting a type parameter are not part of
its name.
String parameterComment()
ParamTag
.
boolean isTypeParameter()
ParamTag
corresponds to a type
parameter. Return false if it corresponds to an ordinary parameter
of a method or constructor.
ParamTag
corresponds to a type
parameter.
|
Doclet API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |