public interface DocProcessor
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 . |
Class<?>[] getRequiredJaxbContextClasses()
resourcedoc
model.
These classes are added to the list of classes when creating the jaxb context
with JAXBContext.newInstance( clazzes );
.null
String[] getCDataElements()
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.null
void processClassDoc(com.sun.javadoc.ClassDoc classDoc, org.glassfish.jersey.server.wadl.internal.generators.resourcedoc.model.ClassDocType classDocType)
ClassDocType
with the information from
the given ClassDoc
.classDoc
- the class javadocclassDocType
- the ClassDocType
to extend. This will later be processed by the
WadlGenerator
s.void processMethodDoc(com.sun.javadoc.MethodDoc methodDoc, org.glassfish.jersey.server.wadl.internal.generators.resourcedoc.model.MethodDocType methodDocType)
MethodDocType.getAny()
to store custom elements.methodDoc
- the MethodDoc
representing the docs of your method.methodDocType
- the related MethodDocType
that will later be processed by the
WadlGenerator
s.void processParamTag(com.sun.javadoc.ParamTag paramTag, com.sun.javadoc.Parameter parameter, org.glassfish.jersey.server.wadl.internal.generators.resourcedoc.model.ParamDocType paramDocType)
ParamDocType
with the information from the
given ParamTag
and Parameter
.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-2017, Oracle and/or its affiliates. All Rights Reserved. Use is subject to license terms.