| com.sun.tools.doclets.internal.toolkit.ConstantsSummaryWriter
All known Subclasses: com.sun.tools.doclets.formats.html.ConstantsSummaryWriterImpl,
| ConstantsSummaryWriter | | public interface ConstantsSummaryWriter (Code) | | The interface for writing constants 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
author:
Jamie Ho
since:
1.5 |
| Method Summary | |
| abstract public void | close()
Close the writer. | | abstract public void | writeConstantMembers(ClassDoc cd, List fields)
Document the given constants. | | abstract public void | writeConstantMembersFooter(ClassDoc cd)
Document the given constants. | | abstract public void | writeConstantMembersHeader(ClassDoc cd)
Write the heading for the current table of constants for a given class. | | abstract public void | writeContentsFooter()
Write the footer for the index. | | abstract public void | writeContentsHeader()
Write the header for the index. | | abstract public void | writeFooter()
Write the footer for the summary. | | abstract public void | writeHeader()
Write the header for the summary. | | abstract public void | writeLinkToPackageContent(PackageDoc pkg, String parsedPackageName, Set WriteedPackageHeaders)
Add the given package name to the index.
Parameters:
pkg - the PackageDoc to index.
Parameters:
parsedPackageName - the parsed package name. | | abstract public void | writePackageName(PackageDoc pkg, String parsedPackageName)
Write the given package name.
Parameters:
pkg - the PackageDoc to index.
Parameters:
parsedPackageName - the parsed package name. |
| writeConstantMembers | | abstract public void writeConstantMembers(ClassDoc cd, List fields)(Code) | | Document the given constants.
Parameters:
cd - the class whose constants are being documented.
Parameters:
fields - the constants being documented. |
| writeConstantMembersFooter | | abstract public void writeConstantMembersFooter(ClassDoc cd)(Code) | | Document the given constants.
Parameters:
cd - the class whose constants are being documented. |
| writeConstantMembersHeader | | abstract public void writeConstantMembersHeader(ClassDoc cd)(Code) | | Write the heading for the current table of constants for a given class.
Parameters:
cd - the class whose constants are being documented. |
| writeContentsFooter | | abstract public void writeContentsFooter()(Code) | | Write the footer for the index.
|
| writeContentsHeader | | abstract public void writeContentsHeader()(Code) | | Write the header for the index.
|
| writeFooter | | abstract public void writeFooter()(Code) | | Write the footer for the summary.
|
| writeHeader | | abstract public void writeHeader()(Code) | | Write the header for the summary.
|
| writeLinkToPackageContent | | abstract public void writeLinkToPackageContent(PackageDoc pkg, String parsedPackageName, Set WriteedPackageHeaders)(Code) | | Add the given package name to the index.
Parameters:
pkg - the PackageDoc to index.
Parameters:
parsedPackageName - the parsed package name. We only Write the first 2 directory levels of the package name. For example, java.lang.ref would be indexed as java.lang.*.
Parameters:
WriteedPackageHeaders - the set of package headers that have already been indexed. We don't want to index something more than once. |
| writePackageName | | abstract public void writePackageName(PackageDoc pkg, String parsedPackageName)(Code) | | Write the given package name.
Parameters:
pkg - the PackageDoc to index.
Parameters:
parsedPackageName - the parsed package name. We only Write the first 2 directory levels of the package name. For example, java.lang.ref would be indexed as java.lang.*. |
|
|