Package spoon.javadoc.internal

Class JavadocBlockTag

java.lang.Object
spoon.javadoc.internal.JavadocBlockTag
All Implemented Interfaces:
Serializable
@Deprecated(forRemoval=true, since="11.0.0") public class JavadocBlockTag extends Object implements Serializable
Deprecated, for removal: This API element is subject to removal in a future version.
Use the new javadoc parser submodule, see Javadoc Parser.
A block tag.

Typically they are found at the end of Javadoc comments.

Examples: @see AnotherClass @since v0.0.1 @author Jim O'Java

See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    JavadocBlockTag(String tagName, String content)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    JavadocBlockTag(String tagName, String paramName, String content)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    JavadocBlockTag(CtJavaDocTag.TagType type, String content)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    JavadocBlockTag(CtJavaDocTag.TagType type, String tagRealName, String content)
    Deprecated, for removal: This API element is subject to removal in a future version.
     

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object o)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    JavadocDescription
    getContent()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    String
    getName()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    String
    getTagName()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    String
    getTagRealName()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    CtJavaDocTag.TagType
    getType()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    int
    hashCode()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    void
    setTagRealName(String tagRealName)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    String
    toString()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    String
    toText()
    Deprecated, for removal: This API element is subject to removal in a future version.
    pretty-prints the Javadoc tag

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • JavadocBlockTag

      public JavadocBlockTag(CtJavaDocTag.TagType type, String content)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • JavadocBlockTag

      public JavadocBlockTag(CtJavaDocTag.TagType type, String tagRealName, String content)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • JavadocBlockTag

      public JavadocBlockTag(String tagName, String content)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • JavadocBlockTag

      public JavadocBlockTag(String tagName, String paramName, String content)
      Deprecated, for removal: This API element is subject to removal in a future version.

  • Method Details

    • getType

      public CtJavaDocTag.TagType getType()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getContent

      public JavadocDescription getContent()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getName

      public String getName()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getTagName

      public String getTagName()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getTagRealName

      public String getTagRealName()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • setTagRealName

      public void setTagRealName(String tagRealName)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • toText

      public String toText()
      Deprecated, for removal: This API element is subject to removal in a future version.
      pretty-prints the Javadoc tag

    • equals

      public boolean equals(Object o)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Overrides:
      toString in class Object