Uses of Class
org.exolab.javasource.JDocDescriptor

Packages that use JDocDescriptor

Package	Description
org.exolab.javasource	This package contains classes that represent Java Source objects for Castor XML code generator.

Uses of JDocDescriptor in org.exolab.javasource

Methods in org.exolab.javasource that return JDocDescriptor

Modifier and Type	Method	Description
static JDocDescriptor	JDocDescriptor.createAuthorDesc()	Creates a new, empty @author JavaDoc descriptor.
static JDocDescriptor	JDocDescriptor.createAuthorDesc(String name)	Creates a new @author JavaDoc descriptor with the provided author name string.
static JDocDescriptor	JDocDescriptor.createExceptionDesc()	Creates a new, empty @exception JavaDoc descriptor.
static JDocDescriptor	JDocDescriptor.createExceptionDesc(String name, String desc)	Creates a new @exception JavaDoc descriptor with a given exception name and a description of when the exception is thrown.
static JDocDescriptor	JDocDescriptor.createParamDesc()	Creates a new, empty @param JavaDoc descriptor.
static JDocDescriptor	JDocDescriptor.createParamDesc(String name, String desc)	Creates a new @param JavaDoc descriptor with the given parameter name and description.
static JDocDescriptor	JDocDescriptor.createReferenceDesc()	Creates a new, empty @reference JavaDoc descriptor.
static JDocDescriptor	JDocDescriptor.createReferenceDesc(String name)	Creates a new @reference JavaDoc descriptor with the provided reference string.
static JDocDescriptor	JDocDescriptor.createReturnDesc()	Creates a new, empty @return JavaDoc descriptor.
static JDocDescriptor	JDocDescriptor.createReturnDesc(String desc)	Creates a new @return JavaDoc descriptor with the provided description of what is returned.
static JDocDescriptor	JDocDescriptor.createVersionDesc()	Creates a new, empty @version JavaDoc descriptor.
static JDocDescriptor	JDocDescriptor.createVersionDesc(String version)	Creates a new @version JavaDoc descriptor with the provided version string.
JDocDescriptor	JDocComment.getParamDescriptor(String name)	Returns the Parameter Descriptor associated with the given name.

Methods in org.exolab.javasource that return types with arguments of type JDocDescriptor

Modifier and Type	Method	Description
Enumeration<JDocDescriptor>	JDocComment.getDescriptors()	Returns an Enumeration of the parameters of this JDocComment.

Methods in org.exolab.javasource with parameters of type JDocDescriptor

Modifier and Type	Method	Description
void	JDocComment.addDescriptor(JDocDescriptor jdesc)	Adds the given JDocDescriptor to this JDocComment.
protected short	JDocDescriptor.compareTo(JDocDescriptor jdd)	Compares the type of this JDocDescriptor with the given descriptor.

Constructors in org.exolab.javasource with parameters of type JDocDescriptor

Modifier	Constructor	Description
	JDocComment(JDocDescriptor jdesc)	Creates a new JavaDoc Comment and initializie it with given JDocDescriptor.