public interface DocGenerator
Modifier and Type | Method and Description |
---|---|
String |
getName() |
void |
init(ProcessingEnvironment env)
Init the generator.
|
String |
renderSource(ExecutableElement elt,
String source)
Render the source code of the
elt argument. |
String |
resolveConstructorLink(ExecutableElement elt,
Coordinate coordinate)
Resolve a constructor link.
|
String |
resolveFieldLink(VariableElement elt,
Coordinate coordinate)
Resolve a field link.
|
String |
resolveLabel(Element elt,
String defaultLabel)
Resolve a label.
|
String |
resolveMethodLink(ExecutableElement elt,
Coordinate coordinate)
Resolve a method link.
|
default String |
resolveRelativeFileName(PackageElement docElt,
String relativeFileName)
Resolve the relative file name of a document, the default implementation returns the relativeFileName
parameter.
|
String |
resolveTypeLink(TypeElement elt,
Coordinate coordinate)
Resolve a constructor link.
|
void init(ProcessingEnvironment env)
env
- the processor environmentString getName()
default String resolveRelativeFileName(PackageElement docElt, String relativeFileName)
docElt
- the doc elementrelativeFileName
- the relative file name original valueString renderSource(ExecutableElement elt, String source)
elt
argument.elt
- the element to rendersource
- the Java source of the elementString resolveTypeLink(TypeElement elt, Coordinate coordinate)
elt
- the element linked tocoordinate
- the optional coordinate of the jar containing the elementString resolveConstructorLink(ExecutableElement elt, Coordinate coordinate)
elt
- the element linked tocoordinate
- the optional coordinate of the jar containing the elementString resolveMethodLink(ExecutableElement elt, Coordinate coordinate)
elt
- the element linked tocoordinate
- the optional coordinate of the jar containing the elementString resolveFieldLink(VariableElement elt, Coordinate coordinate)
elt
- the element linked tocoordinate
- the optional coordinate of the jar containing the elementCopyright © 2017. All rights reserved.