Package gw.gosudoc.com.sun.tools.javadoc.main

Class Comment

  • @Deprecated
class Comment
extends java.lang.Object
    Deprecated.
    Comment contains all information in comment part. It allows users to get first sentence of this comment, get comment for different tags...

    This is NOT part of any supported API. If you write code that depends on this, you do so at your own risk. This code and its internal interfaces are subject to change or deletion without notice.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private DocEnv docenv
      Deprecated.
      Doc environment
      private static java.util.regex.Pattern prePat
      Deprecated.
      regex for case-insensitive match for <pre> and </pre> .
      private com.sun.tools.javac.util.ListBuffer<Tag> tagList
      Deprecated.
      sorted comments with different tags.
      private java.lang.String text
      Deprecated.
      text minus any tags.

    • Constructor Summary

      Constructors 
      Constructor Description
      Comment​(DocImpl holder, java.lang.String commentString)
      Deprecated.
      constructor of Comment.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      (package private) java.lang.String commentText()
      Deprecated.
      Return the text of the comment.
      private static int findInlineTagDelim​(java.lang.String inlineText, int searchStart)
      Deprecated.
      Recursively find the index of the closing '}' character for an inline tag and return it.
      (package private) static Tag[] firstSentenceTags​(DocImpl holder, java.lang.String text)
      Deprecated.
      Return array of tags for the locale specific first sentence in the text.
      (package private) static Tag[] getInlineTags​(DocImpl holder, java.lang.String inlinetext)
      Deprecated.
      Return array of tags with text and inline See Tags for a Doc comment.
      private static int inlineTagFound​(DocImpl holder, java.lang.String inlinetext, int start)
      Deprecated.
      Recursively search for the characters '{', '@', followed by name of inline tag and white space, if found return the index of the text following the white space.
      (package private) ParamTag[] paramTags()
      Deprecated.
      Return param tags (excluding type param tags) in this comment.
      private ParamTag[] paramTags​(boolean typeParams)
      Deprecated.
      Return param tags in this comment.
      private static boolean scanForPre​(java.lang.String inlinetext, int start, int end, boolean inPre)
      Deprecated.
       
      (package private) SeeTag[] seeTags()
      Deprecated.
      Return see also tags in this comment.
      (package private) SerialFieldTag[] serialFieldTags()
      Deprecated.
      Return serialField tags in this comment.
      (package private) Tag[] tags()
      Deprecated.
      Return all tags in this comment.
      (package private) Tag[] tags​(java.lang.String tagname)
      Deprecated.
      Return tags of the specified kind in this comment.
      (package private) ThrowsTag[] throwsTags()
      Deprecated.
      Return throws tags in this comment.
      java.lang.String toString()
      Deprecated.
      Return text for this Doc comment.
      (package private) ParamTag[] typeParamTags()
      Deprecated.
      Return type param tags in this comment.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    • Field Detail

      • tagList

        private final com.sun.tools.javac.util.ListBuffer<Tag> tagList
        Deprecated.
        sorted comments with different tags.

      • text

        private java.lang.String text
        Deprecated.
        text minus any tags.

      • docenv

        private final DocEnv docenv
        Deprecated.
        Doc environment

      • prePat

        private static final java.util.regex.Pattern prePat
        Deprecated.
        regex for case-insensitive match for <pre> and </pre> .

    • Constructor Detail

      • Comment

        Comment​(DocImpl holder,
        java.lang.String commentString)
        Deprecated.
        constructor of Comment.

    • Method Detail

      • commentText

        java.lang.String commentText()
        Deprecated.
        Return the text of the comment.

      • tags

        Tag[] tags()
        Deprecated.
        Return all tags in this comment.

      • tags

        Tag[] tags​(java.lang.String tagname)
        Deprecated.
        Return tags of the specified kind in this comment.

      • throwsTags

        ThrowsTag[] throwsTags()
        Deprecated.
        Return throws tags in this comment.

      • paramTags

        ParamTag[] paramTags()
        Deprecated.
        Return param tags (excluding type param tags) in this comment.

      • typeParamTags

        ParamTag[] typeParamTags()
        Deprecated.
        Return type param tags in this comment.

      • paramTags

        private ParamTag[] paramTags​(boolean typeParams)
        Deprecated.
        Return param tags in this comment. If typeParams is true include only type param tags, otherwise include only ordinary param tags.

      • seeTags

        SeeTag[] seeTags()
        Deprecated.
        Return see also tags in this comment.

      • serialFieldTags

        SerialFieldTag[] serialFieldTags()
        Deprecated.
        Return serialField tags in this comment.

      • getInlineTags

        static Tag[] getInlineTags​(DocImpl holder,
                           java.lang.String inlinetext)
        Deprecated.
        Return array of tags with text and inline See Tags for a Doc comment.

      • scanForPre

        private static boolean scanForPre​(java.lang.String inlinetext,
                                  int start,
                                  int end,
                                  boolean inPre)
        Deprecated.

      • findInlineTagDelim

        private static int findInlineTagDelim​(java.lang.String inlineText,
                                      int searchStart)
        Deprecated.
        Recursively find the index of the closing '}' character for an inline tag and return it. If it can't be found, return -1.
        Parameters:
        inlineText - the text to search in.
        searchStart - the index of the place to start searching at.
        Returns:
        the index of the closing '}' character for an inline tag. If it can't be found, return -1.

      • inlineTagFound

        private static int inlineTagFound​(DocImpl holder,
                                  java.lang.String inlinetext,
                                  int start)
        Deprecated.
        Recursively search for the characters '{', '@', followed by name of inline tag and white space, if found return the index of the text following the white space. else return -1.

      • firstSentenceTags

        static Tag[] firstSentenceTags​(DocImpl holder,
                               java.lang.String text)
        Deprecated.
        Return array of tags for the locale specific first sentence in the text.

      • toString

        public java.lang.String toString()
        Deprecated.
        Return text for this Doc comment.
        Overrides:
        toString in class java.lang.Object