Class SourceToHTMLConverter
java.lang.Object
gw.gosudoc.com.sun.tools.doclets.formats.html.SourceToHTMLConverter
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 Summary
FieldsModifier and TypeFieldDescriptionprivate final ConfigurationImpl
Deprecated.private static final String
Deprecated.New line to be added to the documentation.private static final int
Deprecated.The number of trailing blank lines at the end of the page.private DocPath
Deprecated.private DocPath
Deprecated.Relative path from the documentation root to the file that is being generated.private final RootDoc
Deprecated.private final Utils
Deprecated. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprivate
SourceToHTMLConverter
(ConfigurationImpl configuration, RootDoc rd, DocPath outputdir) Deprecated. -
Method Summary
Modifier and TypeMethodDescriptionprivate static void
addBlankLines
(Content pre) Deprecated.Add trailing blank lines at the end of the page.private void
Deprecated.Add a line from source to the HTML file that is generated.private static void
Deprecated.Add the line numbers for the source code.void
convertClass
(ClassDoc cd, DocPath outputdir) Deprecated.Convert the given Class to an HTML.void
convertPackage
(PackageDoc pd, DocPath outputdir) Deprecated.Convert the Classes in the given Package to an HTML.static void
convertRoot
(ConfigurationImpl configuration, RootDoc rd, DocPath outputdir) Deprecated.Convert the Classes in the given RootDoc to an HTML.(package private) void
generate()
Deprecated.static String
getAnchorName
(Doc d) Deprecated.Given aDoc
, return an anchor name for it.private static Content
Deprecated.Get the header.Deprecated.Returns a link to the stylesheet file.private void
writeToFile
(Content body, DocPath path) Deprecated.Write the output to the file.
-
Field Details
-
NUM_BLANK_LINES
private static final int NUM_BLANK_LINESDeprecated.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
Deprecated.New line to be added to the documentation. -
configuration
Deprecated. -
utils
Deprecated. -
rootDoc
Deprecated. -
outputdir
Deprecated. -
relativePath
Deprecated.Relative path from the documentation root to the file that is being generated.
-
-
Constructor Details
-
SourceToHTMLConverter
Deprecated.
-
-
Method Details
-
convertRoot
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
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
Deprecated.Convert the given Class to an HTML.- Parameters:
cd
- the class to convert.outputdir
- the name of the directory to output to.
-
writeToFile
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
Deprecated.Returns a link to the stylesheet file.- Returns:
- an HtmlTree for the lINK tag which provides the stylesheet location
-
getHeader
Deprecated.Get the header.- Returns:
- the header content for the HTML file
-
addLineNo
Deprecated.Add the line numbers for the source code.- Parameters:
pre
- the content tree to which the line number will be addedlineno
- The line number
-
addLine
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
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
Deprecated.Given aDoc
, return an anchor name for it.- Parameters:
d
- theDoc
to check.- Returns:
- the name of the anchor.
-