Class HtmlDocument


  • @Deprecated
    public class HtmlDocument
    extends Content
    Deprecated.
    Class for generating an HTML document for 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.

    Author:
    Bhavesh Patel
    • Constructor Detail

      • HtmlDocument

        public HtmlDocument​(Content docType,
                            Content docComment,
                            Content htmlTree)
        Deprecated.
        Constructor to construct an HTML document.
        Parameters:
        docType - document type for the HTML document
        docComment - comment for the document
        htmlTree - HTML tree of the document
      • HtmlDocument

        public HtmlDocument​(Content docType,
                            Content htmlTree)
        Deprecated.
        Constructor to construct an HTML document.
        Parameters:
        docType - document type for the HTML document
        htmlTree - HTML tree of the document
    • Method Detail

      • addContent

        public final void addContent​(Content htmlContent)
        Deprecated.
        Adds content for the HTML document.
        Specified by:
        addContent in class Content
        Parameters:
        htmlContent - html content to be added
      • 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