public class JDocDescriptor extends Object
Modifier and Type | Field | Description |
---|---|---|
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)
|
Modifier and Type | Method | Description |
---|---|---|
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
|
public static final String DEFAULT_VERSION
public static final short PARAM
public static final short EXCEPTION
public static final short RETURN
public static final short AUTHOR
public static final short VERSION
public static final short REFERENCE
protected short compareTo(JDocDescriptor jdd)
jdd
- the javadoc descriptorpublic static JDocDescriptor createAuthorDesc()
public static JDocDescriptor createAuthorDesc(String name)
name
- the author name stringpublic static JDocDescriptor createExceptionDesc()
public static JDocDescriptor createExceptionDesc(String name, String desc)
name
- the exception namedesc
- the description of when the exception is calledpublic static JDocDescriptor createParamDesc()
public static JDocDescriptor createParamDesc(String name, String desc)
name
- the param namedesc
- the param description stringpublic static JDocDescriptor createReferenceDesc()
public static JDocDescriptor createReferenceDesc(String name)
name
- the reference name stringpublic static JDocDescriptor createReturnDesc()
public static JDocDescriptor createReturnDesc(String desc)
desc
- the return descriptionpublic static JDocDescriptor createVersionDesc()
public static JDocDescriptor createVersionDesc(String version)
version
- the version stringpublic String getDescription()
public String getName()
public short getType()
public void setDescription(String desc)
desc
- the description of the object being describedpublic void setName(String name)
name
- the name value of the JavaDoc fieldCopyright © 2001–2018 Codehaus Plexus. All rights reserved.