Class PatternTag

java.lang.Object
com.github.chhorz.javadoc.tags.PatternTag
All Implemented Interfaces:
BlockTag, Tag

public abstract class PatternTag extends Object implements BlockTag
A PatternTag can be used to define a custom Pattern. For this free kind of tag, more methods have to be implemented.
Author:
chhorz
  • Constructor Details

    • PatternTag

      public PatternTag(String tagName, String pattern)
  • Method Details

    • getTagName

      public String getTagName()
      Specified by:
      getTagName in interface Tag
      Returns:
      the Javadoc tag name
    • createPattern

      public String createPattern(String allTagNames)
      Specified by:
      createPattern in interface BlockTag
      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

      public String toString()
      Overrides:
      toString in class Object