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,
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 . |
Class<?>[] getRequiredJaxbContextClasses()
JAXBContext.newInstance( clazzes );
.null
String[] getCDataElements()
null
void processClassDoc(com.sun.javadoc.ClassDoc classDoc, 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, 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, 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 © 2013 Oracle Corporation. All rights reserved.