| com.sun.tools.doclets.internal.toolkit.MemberSummaryWriter
All known Subclasses: com.sun.tools.doclets.formats.html.NestedClassWriterImpl, com.sun.tools.doclets.formats.html.AnnotationTypeRequiredMemberWriterImpl, com.sun.tools.doclets.formats.html.EnumConstantWriterImpl, com.sun.tools.doclets.formats.html.AnnotationTypeOptionalMemberWriterImpl, com.sun.tools.doclets.formats.html.MethodWriterImpl, com.sun.tools.doclets.formats.html.ConstructorWriterImpl, com.sun.tools.doclets.formats.html.FieldWriterImpl,
| MemberSummaryWriter | | public interface MemberSummaryWriter (Code) | | 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
author:
Jamie Ho
since:
1.5 |
| Method Summary | |
| public void | close()
Close the writer. | | public void | writeInheritedMemberSummary(ClassDoc classDoc, ProgramElementDoc member, boolean isFirst, boolean isLast)
Write the inherited member summary for the given class and member. | | public void | writeInheritedMemberSummaryFooter(ClassDoc classDoc)
Write the inherited member summary footer for the given class. | | public void | writeInheritedMemberSummaryHeader(ClassDoc classDoc)
Write the inherited member summary header for the given class. | | public void | writeMemberSummary(ClassDoc classDoc, ProgramElementDoc member, Tag[] firstSentenceTags, boolean isFirst, boolean isLast)
Write the member summary for the given class and member. | | public void | writeMemberSummaryFooter(ClassDoc classDoc)
Write the member summary footer for the given class. | | public void | writeMemberSummaryHeader(ClassDoc classDoc)
Write the member summary header for the given class. |
| writeInheritedMemberSummary | | public void writeInheritedMemberSummary(ClassDoc classDoc, ProgramElementDoc member, boolean isFirst, boolean isLast)(Code) | | Write the inherited member summary for the given class and member.
Parameters:
classDoc - the class the inherited member belongs to.
Parameters:
member - the inherited member that I am summarizing.
Parameters:
isFirst - true if this is the first member in the list.
Parameters:
isLast - true if this is the last member in the list. |
| writeInheritedMemberSummaryFooter | | public void writeInheritedMemberSummaryFooter(ClassDoc classDoc)(Code) | | Write the inherited member summary footer for the given class.
Parameters:
classDoc - the class the summary belongs to. |
| writeInheritedMemberSummaryHeader | | public void writeInheritedMemberSummaryHeader(ClassDoc classDoc)(Code) | | Write the inherited member summary header for the given class.
Parameters:
classDoc - the class the summary belongs to. |
| writeMemberSummary | | public void writeMemberSummary(ClassDoc classDoc, ProgramElementDoc member, Tag[] firstSentenceTags, boolean isFirst, boolean isLast)(Code) | | Write the member summary for the given class and member.
Parameters:
classDoc - the class the summary belongs to.
Parameters:
member - the member that I am summarizing.
Parameters:
firstSentenceTags - the tags for the sentence being documented.
Parameters:
isFirst - true if this is the first member in the list.
Parameters:
isLast - true if this the last member being documented. |
| writeMemberSummaryFooter | | public void writeMemberSummaryFooter(ClassDoc classDoc)(Code) | | Write the member summary footer for the given class.
Parameters:
classDoc - the class the summary belongs to. |
| writeMemberSummaryHeader | | public void writeMemberSummaryHeader(ClassDoc classDoc)(Code) | | Write the member summary header for the given class.
Parameters:
classDoc - the class the summary belongs to. |
|
|