Class Javadoc


  • public class Javadoc
    extends java.lang.Object
    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)

    • Method Detail

      • addBlockTag

        public Javadoc addBlockTag​(java.lang.String tagName,
                                   java.lang.String content)
        For tags like "@return good things" where tagName is "return", and the rest is content.
      • addBlockTag

        public Javadoc addBlockTag​(java.lang.String tagName,
                                   java.lang.String parameter,
                                   java.lang.String content)
        For tags like "@param abc this is a parameter" where tagName is "param", parameter is "abc" and the rest is content.
      • addBlockTag

        public Javadoc addBlockTag​(java.lang.String tagName)
      • toText

        public java.lang.String toText()
        Return the text content of the document. It does not containing trailing spaces and asterisks at the start of the line.
      • toComment

        public JavadocComment toComment()
        Create a JavadocComment, by formatting the text of the Javadoc using no indentation (expecting the pretty printer to do the formatting.)
      • toComment

        public JavadocComment toComment​(java.lang.String indentation)
        Create a JavadocComment, by formatting the text of the Javadoc using the given indentation.
      • getBlockTags

        public java.util.List<JavadocBlockTag> getBlockTags()
        Returns:
        the current List of associated JavadocBlockTags
      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object
      • toString

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