Package com.github.chhorz.javadoc
Class JavaDoc
java.lang.Object
com.github.chhorz.javadoc.JavaDoc
This Javadoc object holds the parsed information.
- Author:
- chhorz
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionThe Javadoc description is the whole text until the first tag.The summary is either defined by the new tag {(at)summary ...} or the first sentence of the textual description.getTags()
This method returns all parsedTag
sThis method returns a list of all tags from the given class.toString()
-
Constructor Details
-
JavaDoc
-
-
Method Details
-
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
The Javadoc description is the whole text until the first tag.- Returns:
- the complete textual description
-
getTags
This method returns all parsedTag
s- Returns:
- a list of all tags
-
getTags
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
-