Top Fields Constructors Methods
io.vertx.docgen

public Class JavaDocGenerator

extends Object
implements DocGenerator
Class Inheritance
All Implemented Interfaces
io.vertx.docgen.DocGenerator
Imports
com.sun.source.tree.BlockTree, .ClassTree, .CompilationUnitTree, .LineMap, .MethodTree, .StatementTree, .Tree, com.sun.source.util.DocTrees, .TreePath, com.sun.tools.javac.code.Type, javax.annotation.processing.ProcessingEnvironment, javax.lang.model.element.Element, .ExecutableElement, .TypeElement, .VariableElement, javax.lang.model.type.ExecutableType, .TypeMirror, java.util.Collections, .Iterator, .List, .Scanner
Author
Julien Viet

Field Summary

Modifier and TypeField and Description
protected DocTrees
docTrees

protected ProcessingEnvironment
processingEnv

Constructor Summary

AccessConstructor and Description
public
JavaDocGenerator()

Method Summary

Modifier and TypeMethod and Description
public String
getName()

Implements io.vertx.docgen.DocGenerator.getName.

public void
init(ProcessingEnvironment
the processor environment
env)

Implements io.vertx.docgen.DocGenerator.init.

Init the generator.

public String

Returns:

the fragment
renderSource(ExecutableElement
the element
elt, String
the source
source)

Implements io.vertx.docgen.DocGenerator.renderSource.

Render the source fragment for the Java language.

public String
renderSource(TypeElement elt, String source)

public String
renderSource(TreePath path, List<? extends Tree> trees, String source)

public String
resolveLabel(Element
the labelled element
elt, String
the default label
defaultLabel)

Implements io.vertx.docgen.DocGenerator.resolveLabel.

Resolve a label.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

docTreesback to summary
protected DocTrees docTrees
processingEnvback to summary
protected ProcessingEnvironment processingEnv

Constructor Detail

JavaDocGeneratorback to summary
public JavaDocGenerator()

Method Detail

getNameback to summary
public String getName()

Implements io.vertx.docgen.DocGenerator.getName.

Returns:String

Doc from io.vertx.docgen.DocGenerator.getName.

the generator name

Annotations
@Override
initback to summary
public void init(ProcessingEnvironment env)

Implements io.vertx.docgen.DocGenerator.init.

Doc from io.vertx.docgen.DocGenerator.init.

Init the generator.

Parameters
env:ProcessingEnvironment

the processor environment

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

Implements io.vertx.docgen.DocGenerator.renderSource.

Render the source fragment for the Java language. Java being the pivot language, we consider this method as the _default_ behavior. This method is final as it must not be overridden by any extension.

Parameters
elt:ExecutableElement

the element

source:String

the source

Returns:String

the fragment

Annotations
@Override
renderSourceback to summary
public String renderSource(TypeElement elt, String source)
renderSourceback to summary
public String renderSource(TreePath path, List<? extends Tree> trees, String source)
resolveConstructorLinkback to summary
public String resolveConstructorLink(ExecutableElement elt, Coordinate coordinate)

Implements io.vertx.docgen.DocGenerator.resolveConstructorLink.

Doc from io.vertx.docgen.DocGenerator.resolveConstructorLink.

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

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

Implements io.vertx.docgen.DocGenerator.resolveFieldLink.

Doc from io.vertx.docgen.DocGenerator.resolveFieldLink.

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

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

Implements io.vertx.docgen.DocGenerator.resolveLabel.

Doc from io.vertx.docgen.DocGenerator.resolveLabel.

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

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

Implements io.vertx.docgen.DocGenerator.resolveMethodLink.

Doc from io.vertx.docgen.DocGenerator.resolveMethodLink.

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

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

Implements io.vertx.docgen.DocGenerator.resolveTypeLink.

Doc from io.vertx.docgen.DocGenerator.resolveTypeLink.

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

Annotations
@Override
toExecutableLinkback to summary
private String toExecutableLink(ExecutableElement elt, String name)