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

Class SourceToHTMLConverter

java.lang.Object
gw.gosudoc.com.sun.tools.doclets.formats.html.SourceToHTMLConverter
@Deprecated public class SourceToHTMLConverter extends Object
Deprecated.
Converts Java Source Code to HTML.

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.

Since:
1.4

  • Field Details

    • NUM_BLANK_LINES

      private static final int NUM_BLANK_LINES
      Deprecated.
      The number of trailing blank lines at the end of the page. This is inserted so that anchors at the bottom of small pages can be reached.
      See Also:

    • NEW_LINE

      private static final String NEW_LINE
      Deprecated.
      New line to be added to the documentation.

    • configuration

      private final ConfigurationImpl configuration
      Deprecated.

    • utils

      private final Utils utils
      Deprecated.

    • rootDoc

      private final RootDoc rootDoc
      Deprecated.

    • outputdir

      private DocPath outputdir
      Deprecated.

    • relativePath

      private DocPath relativePath
      Deprecated.
      Relative path from the documentation root to the file that is being generated.

  • Constructor Details

  • Method Details

    • convertRoot

      public static void convertRoot(ConfigurationImpl configuration, RootDoc rd, DocPath outputdir)
      Deprecated.
      Convert the Classes in the given RootDoc to an HTML.
      Parameters:
      configuration - the configuration.
      rd - the RootDoc to convert.
      outputdir - the name of the directory to output to.

    • generate

      void generate()
      Deprecated.

    • convertPackage

      public void convertPackage(PackageDoc pd, DocPath outputdir)
      Deprecated.
      Convert the Classes in the given Package to an HTML.
      Parameters:
      pd - the Package to convert.
      outputdir - the name of the directory to output to.

    • convertClass

      public void convertClass(ClassDoc cd, DocPath outputdir)
      Deprecated.
      Convert the given Class to an HTML.
      Parameters:
      cd - the class to convert.
      outputdir - the name of the directory to output to.

    • writeToFile

      private void writeToFile(Content body, DocPath path) throws IOException
      Deprecated.
      Write the output to the file.
      Parameters:
      body - the documentation content to be written to the file.
      path - the path for the file.
      Throws:
      IOException

    • getStyleSheetProperties

      public HtmlTree getStyleSheetProperties()
      Deprecated.
      Returns a link to the stylesheet file.
      Returns:
      an HtmlTree for the lINK tag which provides the stylesheet location

    • getHeader

      private static Content getHeader()
      Deprecated.
      Get the header.
      Returns:
      the header content for the HTML file

    • addLineNo

      private static void addLineNo(Content pre, int lineno)
      Deprecated.
      Add the line numbers for the source code.
      Parameters:
      pre - the content tree to which the line number will be added
      lineno - The line number

    • addLine

      private void addLine(Content pre, String line, int currentLineNo)
      Deprecated.
      Add a line from source to the HTML file that is generated.
      Parameters:
      pre - the content tree to which the line will be added.
      line - the string to format.
      currentLineNo - the current number.

    • addBlankLines

      private static void addBlankLines(Content pre)
      Deprecated.
      Add trailing blank lines at the end of the page.
      Parameters:
      pre - the content tree to which the blank lines will be added.

    • getAnchorName

      public static String getAnchorName(Doc d)
      Deprecated.
      Given a Doc, return an anchor name for it.
      Parameters:
      d - the Doc to check.
      Returns:
      the name of the anchor.