Top Description Inners Fields Constructors Methods
io.vertx.codegen.doc

public Class Doc

extends Object
Class Inheritance
Imports
io.vertx.codegen.type.TypeMirrorFactory, javax.annotation.processing.Messager, javax.lang.model.element.Element, .TypeElement, javax.lang.model.util.Elements, .Types, java.util.ArrayList, .Collections, .List, java.util.function.Function, java.util.regex.Matcher, .Pattern
Documention of a program element, the documentation is a composed of a:
Author
Julien Viet

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
Doc.Factory

Doc factory.

Field Summary

Modifier and TypeField and Description
pack-priv final List<Tag>
blockTags

pack-priv final Text
body

private static final Pattern
BODY_START

pack-priv final Text
firstSentence

private static final Pattern
TAG_START

Constructor Summary

AccessConstructor and Description
public
Doc(Text firstSentence)

public
Doc(Text firstSentence, Text body)

public
Doc(Text firstSentence, Text body, List<Tag> blockTags)

public
Doc(String firstSentence)

public
Doc(String firstSentence, String body)

public
Doc(String firstSentence, String body, List<Tag> blockTags)

Method Summary

Modifier and TypeMethod and Description
public static Doc

Returns:

the doc object
create(String
the javadoc
javadoc)

Create and returns a doc object for the specified javadoc argument.

public List<Tag>
getBlockTags()

public Text
getBody()

public Text
getFirstSentence()

public List<Token>

Returns:

the tokens of this comment
getTokens()

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAllwaitwaitwait

Field Detail

blockTagsback to summary
pack-priv final List<Tag> blockTags
bodyback to summary
pack-priv final Text body
BODY_STARTback to summary
private static final Pattern BODY_START
firstSentenceback to summary
pack-priv final Text firstSentence
TAG_STARTback to summary
private static final Pattern TAG_START

Constructor Detail

Docback to summary
public Doc(Text firstSentence)
Docback to summary
public Doc(Text firstSentence, Text body)
Docback to summary
public Doc(Text firstSentence, Text body, List<Tag> blockTags)
Docback to summary
public Doc(String firstSentence)
Docback to summary
public Doc(String firstSentence, String body)
Docback to summary
public Doc(String firstSentence, String body, List<Tag> blockTags)

Method Detail

createback to summary
public static Doc create(String javadoc)

Create and returns a doc object for the specified javadoc argument.

Parameters
javadoc:String

the javadoc

Returns:Doc

the doc object

getBlockTagsback to summary
public List<Tag> getBlockTags()
getBodyback to summary
public Text getBody()
getFirstSentenceback to summary
public Text getFirstSentence()
getTokensback to summary
public List<Token> getTokens()
Returns:List<Token>

the tokens of this comment

toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations
@Override
io.vertx.codegen.doc back to summary

public Class Doc.Factory

extends Object
Class Inheritance
Doc factory.

Field Summary

Modifier and TypeField and Description
private final Elements
elementUtils

private final Messager
messager

private final TypeElement
ownerElt

private final TypeMirrorFactory
typeFactory

private final Types
typeUtils

Constructor Summary

AccessConstructor and Description
public
Factory(Messager messager, Elements elementUtils, Types typeUtils, TypeMirrorFactory typeFactory, TypeElement ownerElt)

Method Summary

Modifier and TypeMethod and Description
public Doc

Returns:

the comment object
createDoc(Element
the element
elt)

When the elt argument has a comment, this comment is parsed and returned as a Doc object.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

elementUtilsback to summary
private final Elements elementUtils
messagerback to summary
private final Messager messager
ownerEltback to summary
private final TypeElement ownerElt
typeFactoryback to summary
private final TypeMirrorFactory typeFactory
typeUtilsback to summary
private final Types typeUtils

Constructor Detail

Factoryback to summary
public Factory(Messager messager, Elements elementUtils, Types typeUtils, TypeMirrorFactory typeFactory, TypeElement ownerElt)

Method Detail

createDocback to summary
public Doc createDoc(Element elt)

When the elt argument has a comment, this comment is parsed and returned as a Doc object.

Parameters
elt:Element

the element

Returns:Doc

the comment object