Package spoon.javadoc.internal

Class JavadocSnippet

java.lang.Object
spoon.javadoc.internal.JavadocSnippet
All Implemented Interfaces:
Serializable, JavadocDescriptionElement
@Deprecated(forRemoval=true, since="11.0.0") public class JavadocSnippet 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.
A piece of text inside a Javadoc description.

For example in A class totally unrelated to String, I swear! we would have two snippets: one before and one after the inline tag (String).

See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    JavadocSnippet(String text)
    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.
     
    int
    hashCode()
    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

    • JavadocSnippet

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

  • Method Details

    • 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