com.github.chhorz.javadoc.tags

Interface BlockTag

All Superinterfaces:

Tag

All Known Implementing Classes:

AuthorTag, CategoryTag, ConstructorTag, DeprecatedTag, ExceptionTag, HiddenTag, ParamTag, PatternTag, PropertyTag, ProvidesTag, ReceiverTag, ReturnTag, SampleTag, SeeTag, SerialDataTag, SerialFieldTag, SerialTag, SinceTag, StructuredTag, SuppressTag, ThrowsTag, UsesTag, VersionTag

public interface BlockTag
extends Tag

Oracle documentation block tags

Author:

chhorz

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	BlockTag.Segment Representation for a javadoc segment of a given tag.

Method Summary

Modifier and Type	Method and Description
String	createPattern(String allTagNames)
List<BlockTag.Segment>	getSegments()
void	putValue(String segmentName, String value)

Methods inherited from interface com.github.chhorz.javadoc.tags.Tag

getTagName

Method Detail

getSegments

List<BlockTag.Segment> getSegments()

Returns:

all names of segments that can be read

putValue

void putValue(String segmentName,
              String value)

Parameters:

segmentName - the segment name for which the value should be saved

value - the value that was parsed for the segment

createPattern

String createPattern(String allTagNames)

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