org.codehaus.modello.plugin.java.javasource
public class JDocDescriptor extends Object
Version: $Revision: 555 $ $Date: 2006-01-29 16:38:08 -0500 (Sun, 29 Jan 2006) $
Field Summary | |
---|---|
static short | AUTHOR
The author descriptor
|
static String | DEFAULT_VERSION
The default version string
|
static short | EXCEPTION
The exception descriptor (exception)
|
static short | PARAM
The param descriptor (param)
|
static short | REFERENCE
The reference descriptor (see)
|
static short | RETURN
The return descriptor (return)
|
static short | VERSION
the version descriptor (version)
|
Method Summary | |
---|---|
protected short | compareTo(JDocDescriptor jdd)
Compares the type of this JDocDescriptor with the given descriptor.
|
static JDocDescriptor | createAuthorDesc()
Creates a new author descriptor |
static JDocDescriptor | createAuthorDesc(String name)
Creates a new author descriptor |
static JDocDescriptor | createExceptionDesc()
Creates a new exception descriptor |
static JDocDescriptor | createExceptionDesc(String name, String desc)
Creates a new exception descriptor |
static JDocDescriptor | createParamDesc()
Creates a new param descriptor |
static JDocDescriptor | createParamDesc(String name, String desc)
Creates a new param descriptor |
static JDocDescriptor | createReferenceDesc()
Creates a new reference descriptor |
static JDocDescriptor | createReferenceDesc(String name)
Creates a new reference descriptor |
static JDocDescriptor | createReturnDesc()
Creates a new return descriptor |
static JDocDescriptor | createReturnDesc(String desc)
Creates a new return descriptor |
static JDocDescriptor | createVersionDesc()
Creates a new version descriptor |
static JDocDescriptor | createVersionDesc(String version)
Creates a new version descriptor |
String | getDescription()
Returns the description String for this descriptor |
String | getName()
Returns the name of the object being described. |
short | getType()
Returns the type of this JDocDescriptor |
void | setDescription(String desc)
Sets the description String for this descriptor |
void | setName(String name)
Sets the name value of the JavaDoc field. |
String | toString()
Returns the String representation of this JDocDescriptor |
Returns: 0 if the two descriptor types are equal, 1 if the type of this descriptor is greater than the given descriptor, or -1 if the type of this descriptor is less than the given descriptor
Returns: the new JDocDescriptor
Parameters: name the author name string
Returns: the new JDocDescriptor
Returns: the new JDocDescriptor
Parameters: name the exception name desc the description of when the exception is called
Returns: the new JDocDescriptor
Returns: the new JDocDescriptor
Parameters: name the param name desc the param description string
Returns: the new JDocDescriptor
Returns: the new JDocDescriptor
Parameters: name the reference name string
Returns: the new JDocDescriptor
Returns: the new JDocDescriptor
Parameters: desc the return description
Returns: the new JDocDescriptor
Returns: the new JDocDescriptor
Parameters: version the version string
Returns: the new JDocDescriptor
Returns: the description string for this descriptor
Returns: the name of the object being described. This
Returns: the type of this JDocDescriptor
Parameters: desc the description of the object being described
Parameters: name the name value of the JavaDoc field
Returns: the String representation of this JDocDescriptor