com.sun.tools.doclets.internal.toolkit
Interface PackageSummaryWriter

All Known Implementing Classes:

PackageWriterImpl

public interface PackageSummaryWriter

The interface for writing package summary output. This code is not part of an API. It is implementation that is subject to change. Do not use it as an API

Since:

1.5

Method Summary

void	close() Close the writer.
java.lang.String	getOutputFileName() Return the name of the output file.
void	writeClassesSummary(ClassDoc[] classes, java.lang.String label) Write the table of classes in this package.
void	writePackageDescription() Print the package description from the "packages.html" file.
void	writePackageFooter() Write the footer for the summary.
void	writePackageHeader(java.lang.String heading) Write the header for the summary.
void	writePackageTags() Print the tag information from the "packages.html" file.
void	writeSummaryFooter() Write the footer for the package summary.
void	writeSummaryHeader() Write the header for the package summary.

Method Detail

getOutputFileName

java.lang.String getOutputFileName()

Return the name of the output file.

Returns:

the name of the output file.

writeSummaryHeader

void writeSummaryHeader()

Write the header for the package summary.

writeSummaryFooter

void writeSummaryFooter()

Write the footer for the package summary.

writeClassesSummary

void writeClassesSummary(ClassDoc[] classes,
                         java.lang.String label)

Write the table of classes in this package.

Parameters:

classes - the array of classes to document.

label - the label for this table.

writePackageHeader

void writePackageHeader(java.lang.String heading)

Write the header for the summary.

Parameters:

heading - Package name.

writePackageDescription

void writePackageDescription()

Print the package description from the "packages.html" file.

writePackageTags

void writePackageTags()

Print the tag information from the "packages.html" file.

writePackageFooter

void writePackageFooter()

Write the footer for the summary.

close

void close()
           throws java.io.IOException

Close the writer.

Throws:

java.io.IOException