xjavadoc
Interface XParameter

All Superinterfaces:

Named, Type

All Known Implementing Classes:

ParameterImpl

public interface XParameter

extends Type, Named

Author:

Aslak Hellesøy

Method Summary

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

Methods inherited from interface xjavadoc.Type

getDimension, getDimensionAsString, getType

Methods inherited from interface xjavadoc.Named

getName

Method Detail

getParamTag

public XTag getParamTag()

Gets the param tag for this parameter.

Returns:

the param tag for this parameter, or null if none is specified.

getDescription

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