com.github.chhorz.javadoc

Class JavaDoc

java.lang.Object

com.github.chhorz.javadoc.JavaDoc

public class JavaDoc
extends Object

This Javadoc object holds the parsed information.

Author:

chhorz

Constructor Summary

Constructors

Constructor and Description
JavaDoc(String summary, String description, List<BlockTag> tags)

Method Summary

Modifier and Type	Method and Description
String	getDescription() The Javadoc description is the whole text until the first tag.
String	getSummary() The summary is either defined by the new tag {(at)summary ...} or the first sentence of the textual description.
List<BlockTag>	getTags() This method returns all parsed Tags
<T extends Tag> List<T>	getTags(Class<T> tagClass) This method returns a list of all tags from the given class.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

JavaDoc

public JavaDoc(String summary,
               String description,
               List<BlockTag> tags)

Method Detail

getSummary

public String getSummary()

The summary is either defined by the new tag {(at)summary ...} or the first sentence of the textual description.

Returns:

the summary of the textual description

getDescription

public String getDescription()

The Javadoc description is the whole text until the first tag.

Returns:

the complete textual description

getTags

public List<BlockTag> getTags()

This method returns all parsed Tags

Returns:

a list of all tags

getTags

public <T extends Tag> List<T> getTags(Class<T> tagClass)

This method returns a list of all tags from the given class.

Parameters:

tagClass - a class to filter the output

Returns:

a list of tags from the given class

toString

public String toString()

Overrides:

toString in class Object