xjavadoc

Interface XParameter

All Superinterfaces:
Named, Type
Known Implementing Classes:
ParameterImpl

public interface XParameter
extends Type, Named

Author:
Aslak Helles?y

Method Summary

String
getDescription()
Gets the description of this parameter.
XTag
getParamTag()
Gets the param tag for this parameter.

Methods inherited from interface xjavadoc.Named

getName

Methods inherited from interface xjavadoc.Type

getDimension, getDimensionAsString, getType

Method Details

getDescription

public String getDescription()
Gets the description of this parameter. This is the text in the param tag preceding the first token.
Returns:
the description of this parameter, or null if there is no corresponding param tag.

getParamTag

public XTag getParamTag()
Gets the param tag for this parameter.
Returns:
the param tag for this parameter, or null if none is specified.