public class ParameterDescription extends java.lang.Object
Modifier and Type | Field and Description |
---|---|
boolean |
allowNull |
boolean |
cache |
java.lang.String |
defaultPrefix |
java.lang.String |
defaultValue |
boolean |
deprecated |
com.sun.javadoc.FieldDoc |
field |
java.lang.String |
name |
boolean |
required |
java.lang.String |
since |
java.lang.String |
type |
Constructor and Description |
---|
ParameterDescription(com.sun.javadoc.FieldDoc fieldDoc,
java.lang.String name,
java.lang.String type,
java.lang.String defaultValue,
java.lang.String defaultPrefix,
boolean required,
boolean allowNull,
boolean cache,
java.lang.String since,
boolean deprecated) |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
extractDescription()
Extracts the description, converting Text and @link nodes as needed into markup text.
|
public final com.sun.javadoc.FieldDoc field
public final java.lang.String name
public final java.lang.String type
public final java.lang.String defaultValue
public final java.lang.String defaultPrefix
public final boolean required
public final boolean allowNull
public final boolean cache
public final java.lang.String since
public final boolean deprecated
public ParameterDescription(com.sun.javadoc.FieldDoc fieldDoc, java.lang.String name, java.lang.String type, java.lang.String defaultValue, java.lang.String defaultPrefix, boolean required, boolean allowNull, boolean cache, java.lang.String since, boolean deprecated)
public java.lang.String extractDescription() throws java.io.IOException
java.io.IOException
${project.version} - Copyright © 2003-2015 The Apache Software Foundation.