Package org.apache.tapestry5.javadoc

Class ParameterDescription

org.apache.tapestry5.javadoc.ParameterDescription

public class ParameterDescription
extends 

Field Summary

Fields

Modifier and Type	Field	Description
boolean	allowNull
boolean	cache
	defaultPrefix
	defaultValue
boolean	deprecated
	field
	name
boolean	required
	since
	type

Constructor Summary

Constructors

Constructor	Description
fieldDoc, name, type, defaultValue, defaultPrefix, boolean required, boolean allowNull, boolean cache, since, boolean deprecated, DocCommentTreeProvider docCommentTreeProvider)

Method Summary

Modifier and Type	Method	Description
	extractDescription()	Extracts the description, converting Text and @link nodes as needed into markup text.

Methods inherited from class java.lang.

, , , , , , , , , ,

Field Detail

field

public final  field

name

public final  name

type

public final  type

defaultValue

public final  defaultValue

defaultPrefix

public final  defaultPrefix

required

public final boolean required

allowNull

public final boolean allowNull

cache

public final boolean cache

since

public final  since

deprecated

public final boolean deprecated

Constructor Detail

ParameterDescription

public  fieldDoc,
                             name,
                             type,
                             defaultValue,
                             defaultPrefix,
                            boolean required,
                            boolean allowNull,
                            boolean cache,
                             since,
                            boolean deprecated,
                            DocCommentTreeProvider docCommentTreeProvider)

Method Detail

extractDescription

public  extractDescription()
                          throws 

Extracts the description, converting Text and @link nodes as needed into markup text.

Returns:

markup text, ready for writing

Throws:

- if some error occurs.