Spec-Zone .ru спецификации, руководства, описания, API

com.sun.javadoc
Interface ParamTag

All Superinterfaces:

Tag

public interface ParamTag

extends Tag

Represents an @param documentation tag. Parses and stores the name and comment parts of the method/constructor parameter tag.

Method Summary

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

Methods inherited from interface com.sun.javadoc.Tag

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

Method Detail

parameterName

public String parameterName()

Return the name of the parameter associated with this ParamTag.

Returns:

the parameter name.

parameterComment

public String parameterComment()

Return the parameter comment associated with this ParamTag.

Returns:

the parameter comment.