Package spoon.javadoc.internal

Class Javadoc

java.lang.Object
spoon.javadoc.internal.Javadoc
All Implemented Interfaces:
Serializable
@Deprecated(forRemoval=true, since="11.0.0") public class Javadoc 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.
The structured content of a single Javadoc comment.

It is composed by a description and a list of block tags.

An example would be the text contained in this very Javadoc comment. At the moment of this writing this comment does not contain any block tags (such as @see AnotherClass)

See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    Javadoc()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    Javadoc(JavadocDescription description)
    Deprecated, for removal: This API element is subject to removal in a future version.
     

  • Method Summary

    Modifier and Type
    Method
    Description
    Javadoc
    addBlockTag(String tagName)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    Javadoc
    addBlockTag(String tagName, String parameter, String content)
    Deprecated, for removal: This API element is subject to removal in a future version.
    For tags like "@return good things" where tagName is "return", and the rest is content.
    Javadoc
    addBlockTag(JavadocBlockTag blockTag)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    boolean
    equals(Object o)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    List<JavadocBlockTag>
    getBlockTags()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    JavadocDescription
    getDescription()
    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 Javadoc
    parse(String commentContent)
    Deprecated, for removal: This API element is subject to removal in a future version.
    parses the Javadoc content (description + tags)
    static JavadocDescription
    parseText(String text)
    Deprecated, for removal: This API element is subject to removal in a future version.
    parse the description part (before tags) of a Javadoc
    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.
    Return the text content of the document.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • Javadoc

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

    • Javadoc

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

  • Method Details

    • addBlockTag

      public Javadoc addBlockTag(JavadocBlockTag blockTag)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • addBlockTag

      public Javadoc addBlockTag(String tagName, String parameter, String content)
      Deprecated, for removal: This API element is subject to removal in a future version.
      For tags like "@return good things" where tagName is "return", and the rest is content.

    • addBlockTag

      public Javadoc addBlockTag(String tagName)
      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.
      Return the text content of the document. It does not containing trailing spaces and asterisks at the start of the line.

    • getDescription

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

    • getBlockTags

      public List<JavadocBlockTag> getBlockTags()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns:
      the current List of associated JavadocBlockTags

    • 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

    • parseText

      public static JavadocDescription parseText(String text)
      Deprecated, for removal: This API element is subject to removal in a future version.
      parse the description part (before tags) of a Javadoc

    • parse

      public static Javadoc parse(String commentContent)
      Deprecated, for removal: This API element is subject to removal in a future version.
      parses the Javadoc content (description + tags)