Parameter

Implemented in class xdoclet.tagshandler.ParameterTagsHandler.

Block Tags:

forAllMethodParams (block template)

Iterates over all parameters of current method and evaluates the body of the tag for each method.

forAllConstructorParams (block template)

Iterates over all parameters of current constructor and evaluates the body of the tag for each method.

ifHasParams (block template)

Evaluates the body of the tag if current method/constructor has parameters.

[forConstructor] If true, then look for parameters of current constructor instead of current method

Valid Values = {true,false}

parameterList (block template)

Iterates over all parameters in current method and returns a string containing definition of all those parameters.

[includeDefinition] If true then include the parameter type of parameters in the composed string.

Valid Values = {true,false}
[forConstructor] If true, then look for parameters of current constructor instead of current method

Valid Values = {true,false}

forAllParameterTypes (block template)

Gets the value of the parameter specified by paramName of current tag, and assuming the value has the format of a typical method definition extracts of parameter types out of it and evaluates the body for each parameter type. current parameter type can be accessed as <XDtParameter:currentToken/>. Also gives back parameter name as <XDtParameter:currentName/>

paramName The parameter name that its value is used for extracting parameter types out of it.

setMatchValue (block template)

Sets the value of match variable.

value The new value for matchPattern.

Content templates:

methodParamType (content template)

Returns the type of the current method parameter, current method parameter is set inside a forAllMethodParams tag in each iteration. Do not forget to add array dimensions if any.

methodParamDescription (content template)

The methodParamDescription method returns the comment text associated with the ParamTag for the current Parameter

methodParamName (content template)

Returns the name of the current method parameter, current method parameter is set inside a forAllMethodParams tag in each iteration.

currentName (content template)

return name of parameter currently being iterated - ugly hack...

matchValue (content template)

Returns the value of match variable. Match variable serves as a variable for templates, you set it somewhere in template and look it up somewhere else in template.

currentToken (content template)

Returns current token inside forAllClassTagTokens.

skipToken (content template)

Skips current token. Returns empty string.