io.vertx.docgen

Interface DocGenerator

All Known Implementing Classes:

JavaDocGenerator

public interface DocGenerator

A doc generator plugin.

Author:

Julien Viet

Method Summary

Modifier and Type	Method and Description
String	getName()
void	init(ProcessingEnvironment env) Init the generator.
String	renderSource(ExecutableElement elt, String source) Render the source code of the elt argument.
String	resolveConstructorLink(ExecutableElement elt) Resolve a constructor link.
String	resolveFieldLink(VariableElement elt) Resolve a field link.
String	resolveLabel(Element elt, String defaultLabel) Resolve a label.
String	resolveMethodLink(ExecutableElement elt) Resolve a method link.
default String	resolveRelativeFileName(PackageElement docElt, String relativeFileName) Resolve the relative file name of a document, the default implementation returns the relativeFileName parameter.
String	resolveTypeLink(TypeElement elt) Resolve a constructor link.

Method Detail

init

void init(ProcessingEnvironment env)

Init the generator.

Parameters:

env - the processor environment

getName

String getName()

Returns:

the generator name

resolveRelativeFileName

default String resolveRelativeFileName(PackageElement docElt,
                                       String relativeFileName)

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

Parameters:

docElt - the doc element

relativeFileName - the relative file name original value

Returns:

the relative file name

renderSource

String renderSource(ExecutableElement elt,
                    String source)

Render the source code of the elt argument.

Parameters:

elt - the element to render

source - the Java source of the element

Returns:

the rendered source

resolveTypeLink

String resolveTypeLink(TypeElement elt)

Resolve a constructor link.

Parameters:

elt - the element linked to

Returns:

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

resolveConstructorLink

String resolveConstructorLink(ExecutableElement elt)

Resolve a constructor link.

Parameters:

elt - the element linked to

Returns:

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

resolveMethodLink

String resolveMethodLink(ExecutableElement elt)

Resolve a method link.

Parameters:

elt - the element linked to

Returns:

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

resolveFieldLink

String resolveFieldLink(VariableElement elt)

Resolve a field link.

Parameters:

elt - the element linked to

Returns:

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

resolveLabel

String resolveLabel(Element elt,
                    String defaultLabel)

Resolve a label.

Parameters:

elt - the labelled element

defaultLabel - the default label

Returns:

the resolved label or null if a label cannot be resolved