Package com.github.chhorz.javadoc.tags
Class StructuredTag
java.lang.Object
com.github.chhorz.javadoc.tags.StructuredTag
- Direct Known Subclasses:
AuthorTag
,CategoryTag
,ConstructorTag
,DeprecatedTag
,ExceptionTag
,HiddenTag
,ParamTag
,PropertyTag
,ProvidesTag
,ReceiverTag
,ReturnTag
,SampleTag
,SeeTag
,SerialDataTag
,SerialFieldTag
,SerialTag
,SinceTag
,SuppressTag
,ThrowsTag
,UsesTag
,VersionTag
Structured tags are base javadoc block tags of scheme:
@author name-text
@param parameter-name description
- Author:
- chhorz
-
Nested Class Summary
Nested classes/interfaces inherited from interface com.github.chhorz.javadoc.tags.BlockTag
BlockTag.Segment
-
Constructor Summary
Constructors -
Method Summary
-
Constructor Details
-
StructuredTag
-
-
Method Details
-
getTagName
- Specified by:
getTagName
in interfaceTag
- Returns:
- the Javadoc tag name
-
getSegments
- Specified by:
getSegments
in interfaceBlockTag
- Returns:
- all names of segments that can be read
-
getValues
-
putValue
-
createPattern
- Specified by:
createPattern
in interfaceBlockTag
- Parameters:
allTagNames
- the list of all patterns will be calculated on the fly and describes the end of a single tag- Returns:
- the complete pattern string for this tag
-
toString
-