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

All Known Implementing Classes:

AnnotationTypeOptionalMemberWriterImpl, AnnotationTypeRequiredMemberWriterImpl, ConstructorWriterImpl, EnumConstantWriterImpl, FieldWriterImpl, HtmlSerialFieldWriter, HtmlSerialMethodWriter, MethodWriterImpl, NestedClassWriterImpl

public interface MemberSummaryWriter

The interface for writing member 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.
void	writeInheritedMemberSummary(ClassDoc classDoc, ProgramElementDoc member, boolean isFirst, boolean isLast) Write the inherited member summary for the given class and member.
void	writeInheritedMemberSummaryFooter(ClassDoc classDoc) Write the inherited member summary footer for the given class.
void	writeInheritedMemberSummaryHeader(ClassDoc classDoc) Write the inherited member summary header for the given class.
void	writeMemberSummary(ClassDoc classDoc, ProgramElementDoc member, Tag[] firstSentenceTags, boolean isFirst, boolean isLast) Write the member summary for the given class and member.
void	writeMemberSummaryFooter(ClassDoc classDoc) Write the member summary footer for the given class.
void	writeMemberSummaryHeader(ClassDoc classDoc) Write the member summary header for the given class.

Method Detail

writeMemberSummaryHeader

void writeMemberSummaryHeader(ClassDoc classDoc)

Write the member summary header for the given class.

Parameters:

classDoc - the class the summary belongs to.

writeMemberSummary

void writeMemberSummary(ClassDoc classDoc,
                        ProgramElementDoc member,
                        Tag[] firstSentenceTags,
                        boolean isFirst,
                        boolean isLast)

Write the member summary for the given class and member.

Parameters:

classDoc - the class the summary belongs to.

member - the member that I am summarizing.

firstSentenceTags - the tags for the sentence being documented.

isFirst - true if this is the first member in the list.

isLast - true if this the last member being documented.

writeMemberSummaryFooter

void writeMemberSummaryFooter(ClassDoc classDoc)

Write the member summary footer for the given class.

Parameters:

classDoc - the class the summary belongs to.

writeInheritedMemberSummaryHeader

void writeInheritedMemberSummaryHeader(ClassDoc classDoc)

Write the inherited member summary header for the given class.

Parameters:

classDoc - the class the summary belongs to.

writeInheritedMemberSummary

void writeInheritedMemberSummary(ClassDoc classDoc,
                                 ProgramElementDoc member,
                                 boolean isFirst,
                                 boolean isLast)

Write the inherited member summary for the given class and member.

Parameters:

classDoc - the class the inherited member belongs to.

member - the inherited member that I am summarizing.

isFirst - true if this is the first member in the list.

isLast - true if this is the last member in the list.

writeInheritedMemberSummaryFooter

void writeInheritedMemberSummaryFooter(ClassDoc classDoc)

Write the inherited member summary footer for the given class.

Parameters:

classDoc - the class the summary belongs to.

close

void close()
           throws java.io.IOException

Close the writer.

Throws:

java.io.IOException