Interface PackageSummaryWriter
- All Known Implementing Classes:
PackageWriterImpl
Deprecated.
The interface for writing package summary 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.
- Since:
- 1.5
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addClassesSummary
(ClassDoc[] classes, String label, String tableSummary, String[] tableHeader, Content summaryContentTree) Deprecated.Adds the table of classes to the documentation tree.void
addPackageContent
(Content contentTree, Content packageContentTree) Deprecated.Adds the tag information from the "packages.html" or "package-info.java" file to the documentation tree.void
addPackageDescription
(Content packageContentTree) Deprecated.Adds the package description from the "packages.html" file to the documentation tree.void
addPackageFooter
(Content contentTree) Deprecated.Adds the footer to the documentation tree.void
addPackageTags
(Content packageContentTree) Deprecated.Adds the tag information from the "packages.html" file to the documentation tree.void
close()
Deprecated.Close the writer.Deprecated.Get the header for the package content.getPackageHeader
(String heading) Deprecated.Get the header for the summary.Deprecated.Get the header for the package summary.void
printDocument
(Content contentTree) Deprecated.Print the package summary document.
-
Method Details
-
getPackageHeader
Deprecated.Get the header for the summary.- Parameters:
heading
- Package name.- Returns:
- the header to be added to the content tree
-
getContentHeader
Content getContentHeader()Deprecated.Get the header for the package content.- Returns:
- a content tree for the package content header
-
getSummaryHeader
Content getSummaryHeader()Deprecated.Get the header for the package summary.- Returns:
- a content tree with the package summary header
-
addClassesSummary
void addClassesSummary(ClassDoc[] classes, String label, String tableSummary, String[] tableHeader, Content summaryContentTree) Deprecated.Adds the table of classes to the documentation tree.- Parameters:
classes
- the array of classes to document.label
- the label for this table.tableSummary
- the summary string for the tabletableHeader
- array of table headerssummaryContentTree
- the content tree to which the summaries will be added
-
addPackageDescription
Deprecated.Adds the package description from the "packages.html" file to the documentation tree.- Parameters:
packageContentTree
- the content tree to which the package description will be added
-
addPackageTags
Deprecated.Adds the tag information from the "packages.html" file to the documentation tree.- Parameters:
packageContentTree
- the content tree to which the package tags will be added
-
addPackageContent
Deprecated.Adds the tag information from the "packages.html" or "package-info.java" file to the documentation tree.- Parameters:
contentTree
- the content tree to which the package content tree will be addedpackageContentTree
- the package content tree to be added
-
printDocument
Deprecated.Print the package summary document.- Parameters:
contentTree
- the content tree that will be printed- Throws:
IOException
-
close
Deprecated.Close the writer.- Throws:
IOException
-