Package spoon.javadoc.internal

Class JavadocInlineTag

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

For example String

See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static enum 
    JavadocInlineTag.Type
    Deprecated, for removal: This API element is subject to removal in a future version.
    The type of tag: it could either correspond to a known tag (code, docRoot, etc.) or represent an unknown tag.

  • Constructor Summary

    Constructors
    Constructor
    Description
    JavadocInlineTag(String tagName, JavadocInlineTag.Type type, 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.
     
    static JavadocDescriptionElement
    fromText(String text)
    Deprecated, for removal: This API element is subject to removal in a future version.
    parses a Javadoc tag
    String
    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.
     
    JavadocInlineTag.Type
    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.
     
    static String
    nextWord(String string)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Return the next word of the string, in other words it stops when a space is encountered.
    void
    setContent(String content)
    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 fragment

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • JavadocInlineTag

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

  • Method Details

    • nextWord

      public static String nextWord(String string)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Return the next word of the string, in other words it stops when a space is encountered.

    • fromText

      public static JavadocDescriptionElement fromText(String text)
      Deprecated, for removal: This API element is subject to removal in a future version.
      parses a Javadoc tag

    • setContent

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

    • getType

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

    • getContent

      public String 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.

    • toText

      public String toText()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: JavadocDescriptionElement
      pretty-prints the Javadoc fragment
      Specified by:
      toText in interface JavadocDescriptionElement

    • 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