public class DocProcessorWrapper extends Object implements DocProcessor
DocProcessor
wraps multiple DocProcessor
s.Constructor and Description |
---|
DocProcessorWrapper()
Create new
DocProcessorWrapper instance. |
Modifier and Type | Method and Description |
---|---|
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,
org.glassfish.jersey.server.wadl.internal.generators.resourcedoc.model.ClassDocType classDocType)
Use this method to extend the provided
ClassDocType with the information from
the given ClassDoc . |
void |
processMethodDoc(com.sun.javadoc.MethodDoc methodDoc,
org.glassfish.jersey.server.wadl.internal.generators.resourcedoc.model.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,
org.glassfish.jersey.server.wadl.internal.generators.resourcedoc.model.ParamDocType paramDocType)
Use this method to extend the provided
ParamDocType with the information from the
given ParamTag and Parameter . |
public DocProcessorWrapper()
DocProcessorWrapper
instance.public Class<?>[] getRequiredJaxbContextClasses()
DocProcessor
resourcedoc
model.
These classes are added to the list of classes when creating the jaxb context
with JAXBContext.newInstance( clazzes );
.getRequiredJaxbContextClasses
in interface DocProcessor
null
public String[] getCDataElements()
DocProcessor
namespaceURI
and the localname
seems to be an implementation detail of the xerces code.
When processing xml that doesn't use namespaces, simply omit the
namespace prefix as shown in the third CDataElement below.getCDataElements
in interface DocProcessor
null
public void processClassDoc(com.sun.javadoc.ClassDoc classDoc, org.glassfish.jersey.server.wadl.internal.generators.resourcedoc.model.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, org.glassfish.jersey.server.wadl.internal.generators.resourcedoc.model.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, org.glassfish.jersey.server.wadl.internal.generators.resourcedoc.model.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.Copyright © 2007-2023, Oracle and/or its affiliates. All Rights Reserved. Use is subject to license terms.