B C D E G H I J P R S T U W

B

BaseProcessor - Class in io.vertx.docgen

BaseProcessor() - Constructor for class io.vertx.docgen.BaseProcessor

C

Coordinate - Class in io.vertx.docgen

Artifact coordinates.

Coordinate(String, String, String) - Constructor for class io.vertx.docgen.Coordinate

D

defaultRenderSource(ExecutableElement, String) - Method in class io.vertx.docgen.BaseProcessor

Render the source fragment for the Java language.

DocException - Exception in io.vertx.docgen

DocException(Element, String) - Constructor for exception io.vertx.docgen.DocException

DocGenerator - Interface in io.vertx.docgen

A doc generator plugin.

DocGenException - Exception in io.vertx.docgen

DocGenException(Element, String) - Constructor for exception io.vertx.docgen.DocGenException

DocGenProcessor - Class in io.vertx.docgen

A doc gen processor that runs multiple generators at once.

DocGenProcessor() - Constructor for class io.vertx.docgen.DocGenProcessor

docTrees - Variable in class io.vertx.docgen.BaseProcessor

Document - Annotation Type in io.vertx.docgen

Declare a document to process.

E

elementUtils - Variable in class io.vertx.docgen.BaseProcessor

EntityUtils - Class in io.vertx.docgen

An utility class to handle entities.

G

getArtifactId() - Method in class io.vertx.docgen.Coordinate

getElement() - Method in exception io.vertx.docgen.DocGenException

getExtension() - Method in class io.vertx.docgen.BaseProcessor

getGroupId() - Method in class io.vertx.docgen.Coordinate

getName() - Method in class io.vertx.docgen.BaseProcessor

getName() - Method in interface io.vertx.docgen.DocGenerator

getName() - Method in class io.vertx.docgen.DocGenProcessor

getName() - Method in class io.vertx.docgen.JavaDocGenProcessor

getSupportedAnnotationTypes() - Method in class io.vertx.docgen.BaseProcessor

getSupportedOptions() - Method in class io.vertx.docgen.BaseProcessor

getSupportedSourceVersion() - Method in class io.vertx.docgen.BaseProcessor

getVersion() - Method in class io.vertx.docgen.Coordinate

H

handleGen(PackageElement) - Method in class io.vertx.docgen.BaseProcessor

handleGen(PackageElement) - Method in class io.vertx.docgen.DocGenProcessor

handleGen(PackageElement) - Method in class io.vertx.docgen.JavaDocGenProcessor

helper - Variable in class io.vertx.docgen.BaseProcessor

I

init(ProcessingEnvironment) - Method in class io.vertx.docgen.BaseProcessor

init(ProcessingEnvironment) - Method in interface io.vertx.docgen.DocGenerator

Init the generator.

init(ProcessingEnvironment) - Method in class io.vertx.docgen.DocGenProcessor

io.vertx.docgen - package io.vertx.docgen

J

JavaDocGenProcessor - Class in io.vertx.docgen

Processor specialized for Java.

JavaDocGenProcessor() - Constructor for class io.vertx.docgen.JavaDocGenProcessor

P

process(Set<? extends TypeElement>, RoundEnvironment) - Method in class io.vertx.docgen.BaseProcessor

process(Writer, PackageElement) - Method in class io.vertx.docgen.BaseProcessor

R

renderSource(ExecutableElement, String) - Method in class io.vertx.docgen.BaseProcessor

renderSource(ExecutableElement, String) - Method in interface io.vertx.docgen.DocGenerator

Render the source code of the elt argument.

renderSource(ExecutableElement, String) - Method in class io.vertx.docgen.DocGenProcessor

renderSource(ExecutableElement, String) - Method in class io.vertx.docgen.JavaDocGenProcessor

resolveConstructorLink(ExecutableElement, Coordinate) - Method in class io.vertx.docgen.BaseProcessor

resolveConstructorLink(ExecutableElement, Coordinate) - Method in interface io.vertx.docgen.DocGenerator

Resolve a constructor link.

resolveConstructorLink(ExecutableElement, Coordinate) - Method in class io.vertx.docgen.DocGenProcessor

resolveConstructorLink(ExecutableElement, Coordinate) - Method in class io.vertx.docgen.JavaDocGenProcessor

resolveFieldLink(VariableElement, Coordinate) - Method in class io.vertx.docgen.BaseProcessor

resolveFieldLink(VariableElement, Coordinate) - Method in interface io.vertx.docgen.DocGenerator

Resolve a field link.

resolveFieldLink(VariableElement, Coordinate) - Method in class io.vertx.docgen.DocGenProcessor

resolveFieldLink(VariableElement, Coordinate) - Method in class io.vertx.docgen.JavaDocGenProcessor

resolveLabel(Element) - Method in class io.vertx.docgen.BaseProcessor

Resolve a label for the specified element, this is used when a link to a program element does not specify an explicit label.

Subclasses can override it to implement a particular behavior for elements.

resolveLabel(Element, String) - Method in interface io.vertx.docgen.DocGenerator

Resolve a label.

resolveLabel(Element) - Method in class io.vertx.docgen.DocGenProcessor

resolveLinkToPackageDoc(PackageElement) - Method in class io.vertx.docgen.BaseProcessor

resolveMethodLink(ExecutableElement, Coordinate) - Method in class io.vertx.docgen.BaseProcessor

resolveMethodLink(ExecutableElement, Coordinate) - Method in interface io.vertx.docgen.DocGenerator

Resolve a method link.

resolveMethodLink(ExecutableElement, Coordinate) - Method in class io.vertx.docgen.DocGenProcessor

resolveMethodLink(ExecutableElement, Coordinate) - Method in class io.vertx.docgen.JavaDocGenProcessor

resolveTypeLink(TypeElement, Coordinate) - Method in class io.vertx.docgen.BaseProcessor

resolveTypeLink(TypeElement, Coordinate) - Method in interface io.vertx.docgen.DocGenerator

Resolve a constructor link.

resolveTypeLink(TypeElement, Coordinate) - Method in class io.vertx.docgen.DocGenProcessor

resolveTypeLink(TypeElement, Coordinate) - Method in class io.vertx.docgen.JavaDocGenProcessor

S

Source - Annotation Type in io.vertx.docgen

Define a scope for source code inclusion: any link ref in this scope should include the content instead of linking to it.

T

toString() - Method in class io.vertx.docgen.Coordinate

typeUtils - Variable in class io.vertx.docgen.BaseProcessor

U

unescapeEntity(String) - Static method in class io.vertx.docgen.EntityUtils

Computes the character represented by the given entity.

W

write(PackageElement, String) - Method in class io.vertx.docgen.BaseProcessor

B C D E G H I J P R S T U W