Package org.apache.tapestry5.javadoc
Class ParameterDescription
java.lang.Object
org.apache.tapestry5.javadoc.ParameterDescription
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionParameterDescription
(VariableElement fieldDoc, String name, String type, String defaultValue, String defaultPrefix, boolean required, boolean allowNull, boolean cache, String since, boolean deprecated, DocCommentTreeProvider docCommentTreeProvider) -
Method Summary
Modifier and TypeMethodDescriptionExtracts the description, converting Text and @link nodes as needed into markup text.
-
Field Details
-
field
-
name
-
type
-
defaultValue
-
defaultPrefix
-
required
-
allowNull
-
cache
-
since
-
deprecated
-
-
Constructor Details
-
ParameterDescription
public ParameterDescription(VariableElement fieldDoc, String name, String type, String defaultValue, String defaultPrefix, boolean required, boolean allowNull, boolean cache, String since, boolean deprecated, DocCommentTreeProvider docCommentTreeProvider)
-
-
Method Details
-
extractDescription
Extracts the description, converting Text and @link nodes as needed into markup text.- Returns:
- markup text, ready for writing
- Throws:
IOException
- if some error occurs.
-