Package gw.gosudoc.com.sun.tools.doclets.formats.html.markup

Class Comment

  • @Deprecated
public class Comment
extends Content
    Deprecated.
    Class for generating a comment for HTML pages of javadoc output.

    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 java.lang.String commentText
      Deprecated.
       

    • Constructor Summary

      Constructors 
      Constructor Description
      Comment​(java.lang.String comment)
      Deprecated.
      Constructor to construct a Comment object.

    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      void addContent​(Content content)
      Deprecated.
      This method is not supported by the class.
      void addContent​(java.lang.String stringContent)
      Deprecated.
      This method is not supported by the class.
      boolean isEmpty()
      Deprecated.
      Returns true if the content is empty.
      boolean write​(java.io.Writer out, boolean atNewline)
      Deprecated.
      Writes content to a writer.

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • commentText

        private java.lang.String commentText
        Deprecated.

    • Constructor Detail

      • Comment

        public Comment​(java.lang.String comment)
        Deprecated.
        Constructor to construct a Comment object.
        Parameters:
        comment - comment text for the comment

    • Method Detail

      • addContent

        public void addContent​(Content content)
        Deprecated.
        This method is not supported by the class.
        Specified by:
        addContent in class Content
        Parameters:
        content - content that needs to be added
        Throws:
        DocletAbortException - this method will always throw a DocletAbortException because it is not supported.

      • addContent

        public void addContent​(java.lang.String stringContent)
        Deprecated.
        This method is not supported by the class.
        Specified by:
        addContent in class Content
        Parameters:
        stringContent - string content that needs to be added
        Throws:
        DocletAbortException - this method will always throw a DocletAbortException because it is not supported.

      • isEmpty

        public boolean isEmpty()
        Deprecated.
        Returns true if the content is empty.
        Specified by:
        isEmpty in class Content
        Returns:
        true if no content to be displayed else return false

      • write

        public boolean write​(java.io.Writer out,
                     boolean atNewline)
              throws java.io.IOException
        Deprecated.
        Writes content to a writer.
        Specified by:
        write in class Content
        Throws:
        java.io.IOException