org.codehaus.modello.generator.java.javasource
Class JDocDescriptor
java.lang.Object
org.codehaus.modello.generator.java.javasource.JDocDescriptor
public class JDocDescriptor
extends java.lang.Object
A descriptor for a JavaDoc comment
$Revision: 149 $ $Date: 2004-09-29 18:32:16 +0100 (Wed, 29 Sep 2004) $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)
|
AUTHOR
public static final short AUTHOR
The author descriptor
DEFAULT_VERSION
public static final String DEFAULT_VERSION
The default version string
EXCEPTION
public static final short EXCEPTION
The exception descriptor (exception)
PARAM
public static final short PARAM
The param descriptor (param)
REFERENCE
public static final short REFERENCE
The reference descriptor (see)
RETURN
public static final short RETURN
The return descriptor (return)
VERSION
public static final short VERSION
the version descriptor (version)
compareTo
protected short compareTo(JDocDescriptor jdd)
Compares the type of this JDocDescriptor with the given descriptor.
Enables sorting of descriptors.
- 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
createAuthorDesc
public static JDocDescriptor createAuthorDesc()
Creates a new author descriptor
createAuthorDesc
public static JDocDescriptor createAuthorDesc(String name)
Creates a new author descriptor
name
- the author name string
createExceptionDesc
public static JDocDescriptor createExceptionDesc()
Creates a new exception descriptor
createExceptionDesc
public static JDocDescriptor createExceptionDesc(String name,
String desc)
Creates a new exception descriptor
name
- the exception namedesc
- the description of when the exception is called
createParamDesc
public static JDocDescriptor createParamDesc()
Creates a new param descriptor
createParamDesc
public static JDocDescriptor createParamDesc(String name,
String desc)
Creates a new param descriptor
name
- the param namedesc
- the param description string
createReferenceDesc
public static JDocDescriptor createReferenceDesc()
Creates a new reference descriptor
createReferenceDesc
public static JDocDescriptor createReferenceDesc(String name)
Creates a new reference descriptor
name
- the reference name string
createReturnDesc
public static JDocDescriptor createReturnDesc()
Creates a new return descriptor
createReturnDesc
public static JDocDescriptor createReturnDesc(String desc)
Creates a new return descriptor
desc
- the return description
createVersionDesc
public static JDocDescriptor createVersionDesc()
Creates a new version descriptor
createVersionDesc
public static JDocDescriptor createVersionDesc(String version)
Creates a new version descriptor
version
- the version string
getDescription
public String getDescription()
Returns the description String for this descriptor
- the description string for this descriptor
getName
public String getName()
Returns the name of the object being described. This
is valid for the following fields:
- the name of the object being described. This
getType
public short getType()
Returns the type of this JDocDescriptor
- the type of this JDocDescriptor
setDescription
public void setDescription(String desc)
Sets the description String for this descriptor
desc
- the description of the object being described
setName
public void setName(String name)
Sets the name value of the JavaDoc field. This is
only valid for the following fields:
name
- the name value of the JavaDoc field
toString
public String toString()
Returns the String representation of this JDocDescriptor
- the String representation of this JDocDescriptor