|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.sun.jersey.wadl.resourcedoc.DocProcessorWrapper
public class DocProcessorWrapper
This DocProcessor
wraps multiple DocProcessor
s.
Created on: Jul 27, 2008
Constructor Summary | |
---|---|
DocProcessorWrapper()
|
Method Summary | |
---|---|
String[] |
getCDataElements()
specify which of your elements you want to be handled as CDATA. |
Class<?>[] |
getRequiredJaxbContextClasses()
Specify jaxb classes of instances that you add to the resourcedoc model. |
void |
processClassDoc(com.sun.javadoc.ClassDoc classDoc,
ClassDocType classDocType)
Use this method to extend the provided ClassDocType with the information from
the given ClassDoc . |
void |
processMethodDoc(com.sun.javadoc.MethodDoc methodDoc,
MethodDocType methodDocType)
Process the provided methodDoc and add your custom information to the methodDocType. Use e.g. |
void |
processParamTag(com.sun.javadoc.ParamTag paramTag,
com.sun.javadoc.Parameter parameter,
ParamDocType paramDocType)
Use this method to extend the provided ParamDocType with the information from the
given ParamTag and Parameter . |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public DocProcessorWrapper()
Method Detail |
---|
public Class<?>[] getRequiredJaxbContextClasses()
DocProcessor
JAXBContext.newInstance( clazzes );
.
getRequiredJaxbContextClasses
in interface DocProcessor
null
public String[] getCDataElements()
DocProcessor
getCDataElements
in interface DocProcessor
null
public void processClassDoc(com.sun.javadoc.ClassDoc classDoc, ClassDocType classDocType)
DocProcessor
ClassDocType
with the information from
the given ClassDoc
.
processClassDoc
in interface DocProcessor
classDoc
- the class javadocclassDocType
- the ClassDocType
to extend. This will later be processed by the WadlGenerator
s.public void processMethodDoc(com.sun.javadoc.MethodDoc methodDoc, MethodDocType methodDocType)
DocProcessor
MethodDocType.getAny()
to store custom elements.
processMethodDoc
in interface DocProcessor
methodDoc
- the MethodDoc
representing the docs of your method.methodDocType
- the related MethodDocType
that will later be processed by the WadlGenerator
s.public void processParamTag(com.sun.javadoc.ParamTag paramTag, com.sun.javadoc.Parameter parameter, ParamDocType paramDocType)
DocProcessor
ParamDocType
with the information from the
given ParamTag
and Parameter
.
processParamTag
in interface DocProcessor
paramTag
- the parameter javadocparameter
- the parameter (that is documented or not)paramDocType
- the ParamDocType
to extend. This will later be processed by the WadlGenerator
s.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |