Top Description Methods
io.vertx.docgen

public Interface DocGenerator

Known Direct Implementers
io.vertx.docgen.JavaDocGenerator
Imports
javax.annotation.processing.ProcessingEnvironment, javax.lang.model.element.Element, .ExecutableElement, .PackageElement, .TypeElement, .VariableElement
A doc generator plugin.
Author
Julien Viet

Method Summary

Modifier and TypeMethod and Description
public String

Returns:

the generator name
getName()

public void
init(ProcessingEnvironment
the processor environment
env)

Init the generator.

public String

Returns:

the rendered source
renderSource(ExecutableElement
the element to render
elt, String
the Java source of the element
source)

Render the source code of the elt argument.

public String

Returns:

the resolved label or null if a label cannot be resolved
resolveLabel(Element
the labelled element
elt, String
the default label
defaultLabel)

Resolve a label.

public default String

Returns:

the relative file name
resolveRelativeFileName(PackageElement
the doc element
docElt, String
the relative file name original value
relativeFileName)

Resolve the relative file name of a document, the default implementation returns the relativeFileName parameter.

Method Detail

getNameback to summary
public String getName()
Returns:String

the generator name

initback to summary
public void init(ProcessingEnvironment env)

Init the generator.

Parameters
env:ProcessingEnvironment

the processor environment

renderSourceback to summary
public String renderSource(ExecutableElement elt, String source)

Render the source code of the elt argument.

Parameters
elt:ExecutableElement

the element to render

source:String

the Java source of the element

Returns:String

the rendered source

resolveConstructorLinkback to summary
public String resolveConstructorLink(ExecutableElement elt, Coordinate coordinate)

Resolve a constructor link.

Parameters
elt:ExecutableElement

the element linked to

coordinate:Coordinate

the optional coordinate of the jar containing the element

Returns:String

the resolved http link or null if the link cannot be resolved

resolveFieldLinkback to summary
public String resolveFieldLink(VariableElement elt, Coordinate coordinate)

Resolve a field link.

Parameters
elt:VariableElement

the element linked to

coordinate:Coordinate

the optional coordinate of the jar containing the element

Returns:String

the resolved http link or null if the link cannot be resolved

resolveLabelback to summary
public String resolveLabel(Element elt, String defaultLabel)

Resolve a label.

Parameters
elt:Element

the labelled element

defaultLabel:String

the default label

Returns:String

the resolved label or null if a label cannot be resolved

resolveMethodLinkback to summary
public String resolveMethodLink(ExecutableElement elt, Coordinate coordinate)

Resolve a method link.

Parameters
elt:ExecutableElement

the element linked to

coordinate:Coordinate

the optional coordinate of the jar containing the element

Returns:String

the resolved http link or null if the link cannot be resolved

resolveRelativeFileNameback to summary
public default String resolveRelativeFileName(PackageElement docElt, String relativeFileName)

Resolve the relative file name of a document, the default implementation returns the relativeFileName parameter.

Parameters
docElt:PackageElement

the doc element

relativeFileName:String

the relative file name original value

Returns:String

the relative file name

resolveTypeLinkback to summary
public String resolveTypeLink(TypeElement elt, Coordinate coordinate)

Resolve a constructor link.

Parameters
elt:TypeElement

the element linked to

coordinate:Coordinate

the optional coordinate of the jar containing the element

Returns:String

the resolved http link or null if the link cannot be resolved