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

Class Comment

java.lang.Object
gw.gosudoc.com.sun.tools.doclets.internal.toolkit.Content
gw.gosudoc.com.sun.tools.doclets.formats.html.markup.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 String
    commentText
    Deprecated.
     

  • Constructor Summary

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

  • Method Summary

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

    Methods inherited from class gw.gosudoc.com.sun.tools.doclets.internal.toolkit.Content

    charCount, isValid, nullCheck, toString

    Methods inherited from class java.lang.Object

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

  • Field Details

    • commentText

      private String commentText
      Deprecated.

  • Constructor Details

    • Comment

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

  • Method Details

    • 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(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(Writer out, boolean atNewline) throws IOException
      Deprecated.
      Writes content to a writer.
      Specified by:
      write in class Content
      Throws:
      IOException