Class JavaDoc


  • public class JavaDoc
    extends java.lang.Object
    This Javadoc object holds the parsed information.
    Author:
    chhorz
    • Constructor Summary

      Constructors 
      Constructor Description
      JavaDoc​(java.lang.String summary, java.lang.String description, java.util.List<BlockTag> tags)  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getDescription()
      The Javadoc description is the whole text until the first tag.
      java.lang.String getSummary()
      The summary is either defined by the new tag {(at)summary ...} or the first sentence of the textual description.
      java.util.List<BlockTag> getTags()
      This method returns all parsed Tags
      <T extends Tag>
      java.util.List<T>
      getTags​(java.lang.Class<T> tagClass)
      This method returns a list of all tags from the given class.
      java.lang.String toString()  
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • JavaDoc

        public JavaDoc​(java.lang.String summary,
                       java.lang.String description,
                       java.util.List<BlockTag> tags)
    • Method Detail

      • getSummary

        public java.lang.String getSummary()
        The summary is either defined by the new tag {(at)summary ...} or the first sentence of the textual description.
        Returns:
        the summary of the textual description
      • getDescription

        public java.lang.String getDescription()
        The Javadoc description is the whole text until the first tag.
        Returns:
        the complete textual description
      • getTags

        public java.util.List<BlockTag> getTags()
        This method returns all parsed Tags
        Returns:
        a list of all tags
      • getTags

        public <T extends Tag> java.util.List<T> getTags​(java.lang.Class<T> tagClass)
        This method returns a list of all tags from the given class.
        Parameters:
        tagClass - a class to filter the output
        Returns:
        a list of tags from the given class
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object