Package org.jboss.forge.roaster.model

Interface JavaDoc<O>

All Superinterfaces:
Internal, Origin<O>
All Known Subinterfaces:
JavaDocSource<O>
public interface JavaDoc<O> extends Internal, Origin<O>
A JavaDoc represents Javadoc-style doc comment
Author:
George Gastaldi

  • Method Details

    • getText

      String getText()
      Returns the text for this JavaDoc, excluding tags

    • getFullText

      String getFullText()
      Returns the full text for this JavaDoc, including tags

    • getTagNames

      Set<String> getTagNames()
      Return the tag names for this JavaDoc

    • getTags

      List<JavaDocTag> getTags(String tagName)
      Returns a list of JavaDocTag values for the given tag name (eg: @param) or an empty list if not found

    • getTags

      List<JavaDocTag> getTags()
      Returns a list of JavaDocTag values for the given tag name (eg: @param) or an empty list if not found