Package io.vertx.docgen
Class JavaDocGenerator
- java.lang.Object
-
- io.vertx.docgen.JavaDocGenerator
-
- All Implemented Interfaces:
DocGenerator
public class JavaDocGenerator extends java.lang.Object implements DocGenerator
- Author:
- Julien Viet
-
-
Field Summary
Fields Modifier and Type Field Description protected com.sun.source.util.DocTrees
docTrees
protected javax.annotation.processing.ProcessingEnvironment
processingEnv
-
Constructor Summary
Constructors Constructor Description JavaDocGenerator()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getName()
void
init(javax.annotation.processing.ProcessingEnvironment env)
Init the generator.java.lang.String
renderSource(com.sun.source.util.TreePath path, java.util.List<? extends com.sun.source.tree.Tree> trees, java.lang.String source)
java.lang.String
renderSource(javax.lang.model.element.ExecutableElement elt, java.lang.String source)
Render the source fragment for the Java language.java.lang.String
renderSource(javax.lang.model.element.TypeElement elt, java.lang.String source)
java.lang.String
resolveConstructorLink(javax.lang.model.element.ExecutableElement elt)
Resolve a constructor link.java.lang.String
resolveFieldLink(javax.lang.model.element.VariableElement elt)
Resolve a field link.java.lang.String
resolveLabel(javax.lang.model.element.Element elt, java.lang.String defaultLabel)
Resolve a label.java.lang.String
resolveMethodLink(javax.lang.model.element.ExecutableElement elt)
Resolve a method link.java.lang.String
resolveTypeLink(javax.lang.model.element.TypeElement elt)
Resolve a constructor link.-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface io.vertx.docgen.DocGenerator
resolveRelativeFileName
-
-
-
-
Method Detail
-
init
public void init(javax.annotation.processing.ProcessingEnvironment env)
Description copied from interface:DocGenerator
Init the generator.- Specified by:
init
in interfaceDocGenerator
- Parameters:
env
- the processor environment
-
getName
public java.lang.String getName()
- Specified by:
getName
in interfaceDocGenerator
- Returns:
- the generator name
-
resolveTypeLink
public java.lang.String resolveTypeLink(javax.lang.model.element.TypeElement elt)
Description copied from interface:DocGenerator
Resolve a constructor link.- Specified by:
resolveTypeLink
in interfaceDocGenerator
- Parameters:
elt
- the element linked to- Returns:
- the resolved http link or null if the link cannot be resolved
-
resolveConstructorLink
public java.lang.String resolveConstructorLink(javax.lang.model.element.ExecutableElement elt)
Description copied from interface:DocGenerator
Resolve a constructor link.- Specified by:
resolveConstructorLink
in interfaceDocGenerator
- Parameters:
elt
- the element linked to- Returns:
- the resolved http link or null if the link cannot be resolved
-
resolveMethodLink
public java.lang.String resolveMethodLink(javax.lang.model.element.ExecutableElement elt)
Description copied from interface:DocGenerator
Resolve a method link.- Specified by:
resolveMethodLink
in interfaceDocGenerator
- Parameters:
elt
- the element linked to- Returns:
- the resolved http link or null if the link cannot be resolved
-
resolveLabel
public java.lang.String resolveLabel(javax.lang.model.element.Element elt, java.lang.String defaultLabel)
Description copied from interface:DocGenerator
Resolve a label.- Specified by:
resolveLabel
in interfaceDocGenerator
- Parameters:
elt
- the labelled elementdefaultLabel
- the default label- Returns:
- the resolved label or null if a label cannot be resolved
-
resolveFieldLink
public java.lang.String resolveFieldLink(javax.lang.model.element.VariableElement elt)
Description copied from interface:DocGenerator
Resolve a field link.- Specified by:
resolveFieldLink
in interfaceDocGenerator
- Parameters:
elt
- the element linked to- Returns:
- the resolved http link or null if the link cannot be resolved
-
renderSource
public java.lang.String renderSource(javax.lang.model.element.ExecutableElement elt, java.lang.String source)
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.- Specified by:
renderSource
in interfaceDocGenerator
- Parameters:
elt
- the elementsource
- the source- Returns:
- the fragment
-
renderSource
public java.lang.String renderSource(javax.lang.model.element.TypeElement elt, java.lang.String source)
-
renderSource
public java.lang.String renderSource(com.sun.source.util.TreePath path, java.util.List<? extends com.sun.source.tree.Tree> trees, java.lang.String source)
-
-