A B D E F G H I J L P R S T U W
All Classes All Packages
All Classes All Packages
All Classes All Packages
A
- applyPostProcessors(String, String) - Method in class io.vertx.docgen.BaseProcessor
-
Apply post-processors.
- applyVariableSubstitution(String) - Method in class io.vertx.docgen.BaseProcessor
-
Replace `@{var} by the variable value passed to the annotation processor.
B
- BaseProcessor - Class in io.vertx.docgen
- BaseProcessor() - Constructor for class io.vertx.docgen.BaseProcessor
- BLOCK_DECLARATION - Static variable in interface io.vertx.docgen.PostProcessor
D
- DocGenerator - Interface in io.vertx.docgen
-
A doc generator plugin.
- DocGenException - Exception in io.vertx.docgen
- DocGenException(String) - Constructor for exception io.vertx.docgen.DocGenException
- 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
- DocGenProcessor(DocGenerator...) - Constructor for class io.vertx.docgen.DocGenProcessor
- docTrees - Variable in class io.vertx.docgen.BaseProcessor
- docTrees - Variable in class io.vertx.docgen.JavaDocGenerator
- Document - Annotation Type in io.vertx.docgen
-
Declare a document to process.
E
- EMPTY_CONTENT - Static variable in interface io.vertx.docgen.PostProcessor
- EntityUtils - Class in io.vertx.docgen
-
An utility class to handle entities.
F
- fileName() - Method in annotation type io.vertx.docgen.Document
G
- generator() - Method in class io.vertx.docgen.JavaDocGenProcessor
- generators() - Method in class io.vertx.docgen.BaseProcessor
- generators() - Method in class io.vertx.docgen.DocGenProcessor
- generators() - Method in class io.vertx.docgen.JavaDocGenProcessor
- getBlockContent(Iterator<String>) - Static method in interface io.vertx.docgen.PostProcessor
- getExtension() - Method in class io.vertx.docgen.BaseProcessor
- getName() - Method in interface io.vertx.docgen.DocGenerator
- getName() - Method in class io.vertx.docgen.JavaDocGenerator
- getName() - Method in class io.vertx.docgen.LanguageFilterPostProcessor
- getName() - Method in interface io.vertx.docgen.PostProcessor
- getPostProcessor(String) - Method in class io.vertx.docgen.BaseProcessor
- getProcessorAttributes(String) - Static method in interface io.vertx.docgen.PostProcessor
- getProcessorName(String) - Static method in interface io.vertx.docgen.PostProcessor
- getSupportedAnnotationTypes() - Method in class io.vertx.docgen.BaseProcessor
- getSupportedOptions() - Method in class io.vertx.docgen.BaseProcessor
- getSupportedSourceVersion() - Method in class io.vertx.docgen.BaseProcessor
H
- 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
- init(ProcessingEnvironment) - Method in class io.vertx.docgen.JavaDocGenerator
- io.vertx.docgen - package io.vertx.docgen
- isBlockDeclaration(String) - Static method in interface io.vertx.docgen.PostProcessor
J
- JavaDocGenerator - Class in io.vertx.docgen
- JavaDocGenerator() - Constructor for class io.vertx.docgen.JavaDocGenerator
- JavaDocGenProcessor - Class in io.vertx.docgen
-
Processor specialized for Java.
- JavaDocGenProcessor() - Constructor for class io.vertx.docgen.JavaDocGenProcessor
L
- LanguageFilterPostProcessor - Class in io.vertx.docgen
-
A post processor filtering out content not matching the current processor language.
- LanguageFilterPostProcessor() - Constructor for class io.vertx.docgen.LanguageFilterPostProcessor
P
- postProcess(String, String) - Method in class io.vertx.docgen.BaseProcessor
- PostProcessor - Interface in io.vertx.docgen
-
Post processor interface.
- postProcessors - Variable in class io.vertx.docgen.BaseProcessor
- process(String, String, String...) - Method in class io.vertx.docgen.LanguageFilterPostProcessor
- process(String, String, String...) - Method in interface io.vertx.docgen.PostProcessor
- process(Set<? extends TypeElement>, RoundEnvironment) - Method in class io.vertx.docgen.BaseProcessor
- processingEnv - Variable in class io.vertx.docgen.JavaDocGenerator
R
- registerPostProcessor(PostProcessor) - Method in class io.vertx.docgen.BaseProcessor
- renderSource(TreePath, List<? extends Tree>, String) - Method in class io.vertx.docgen.JavaDocGenerator
- 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.JavaDocGenerator
-
Render the source fragment for the Java language.
- renderSource(TypeElement, String) - Method in class io.vertx.docgen.JavaDocGenerator
- resolutions - Variable in class io.vertx.docgen.BaseProcessor
- resolveConstructorLink(ExecutableElement) - Method in interface io.vertx.docgen.DocGenerator
-
Resolve a constructor link.
- resolveConstructorLink(ExecutableElement) - Method in class io.vertx.docgen.JavaDocGenerator
- resolveFieldLink(VariableElement) - Method in interface io.vertx.docgen.DocGenerator
-
Resolve a field link.
- resolveFieldLink(VariableElement) - Method in class io.vertx.docgen.JavaDocGenerator
- resolveLabel(Element, String) - Method in interface io.vertx.docgen.DocGenerator
-
Resolve a label.
- resolveLabel(Element, String) - Method in class io.vertx.docgen.JavaDocGenerator
- resolveLinkToPackageDoc(PackageElement) - Method in class io.vertx.docgen.BaseProcessor
- resolveMethodLink(ExecutableElement) - Method in interface io.vertx.docgen.DocGenerator
-
Resolve a method link.
- resolveMethodLink(ExecutableElement) - Method in class io.vertx.docgen.JavaDocGenerator
- resolveRelativeFileName(PackageElement, String) - Method in interface io.vertx.docgen.DocGenerator
-
Resolve the relative file name of a document, the default implementation returns the relativeFileName parameter.
- resolveTypeLink(TypeElement) - Method in interface io.vertx.docgen.DocGenerator
-
Resolve a constructor link.
- resolveTypeLink(TypeElement) - Method in class io.vertx.docgen.JavaDocGenerator
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.
- sources - Variable in class io.vertx.docgen.BaseProcessor
- syntax - Variable in class io.vertx.docgen.BaseProcessor
T
- translate() - Method in annotation type io.vertx.docgen.Source
-
Enables or disables the translation of the annotated example.
U
- unescapeEntity(String) - Static method in class io.vertx.docgen.EntityUtils
-
Computes the character represented by the given entity.
W
- write(DocGenerator, BaseProcessor.Doc, String) - Method in class io.vertx.docgen.BaseProcessor
All Classes All Packages