io.vertx.codegen.doc

Class Doc

java.lang.Object

io.vertx.codegen.doc.Doc

public class Doc
extends Object

Documention of a program element, the documentation is a composed of a:

• a first sentence
• an optional body
• a list of block tags

Author:

Julien Viet

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Doc.Factory Doc factory.

Constructor Summary

Constructors

Constructor and Description
Doc(String firstSentence)
Doc(String firstSentence, String body)
Doc(String firstSentence, String body, List<Tag> blockTags)
Doc(Text firstSentence)
Doc(Text firstSentence, Text body)
Doc(Text firstSentence, Text body, List<Tag> blockTags)

Method Summary

Modifier and Type	Method and Description
static Doc	create(String javadoc) Create and returns a doc object for the specified javadoc argument.
List<Tag>	getBlockTags()
Text	getBody()
Text	getFirstSentence()
List<Token>	getTokens()
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Doc

public Doc(Text firstSentence)

Doc

public Doc(Text firstSentence,
           Text body)

Doc

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

Doc

public Doc(String firstSentence)

Doc

public Doc(String firstSentence,
           String body)

Doc

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

Method Detail

create

public static Doc create(String javadoc)

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

Parameters:

javadoc - the javadoc

Returns:

the doc object

getTokens

public List<Token> getTokens()

Returns:

the tokens of this comment

getFirstSentence

public Text getFirstSentence()

getBody

public Text getBody()

getBlockTags

public List<Tag> getBlockTags()

toString

public String toString()

Overrides:

toString in class Object