Interface MemberSummaryWriter
- All Known Implementing Classes:
AnnotationTypeFieldWriterImpl
,AnnotationTypeOptionalMemberWriterImpl
,AnnotationTypeRequiredMemberWriterImpl
,ConstructorWriterImpl
,EnumConstantWriterImpl
,FieldWriterImpl
,HtmlSerialFieldWriter
,HtmlSerialMethodWriter
,MethodWriterImpl
,NestedClassWriterImpl
,PropertyWriterImpl
Deprecated.
The interface for writing member 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
addInheritedMemberSummary
(ClassDoc classDoc, ProgramElementDoc member, boolean isFirst, boolean isLast, Content linksTree) Deprecated.Add the inherited member summary for the given class and member.void
addMemberSummary
(ClassDoc classDoc, ProgramElementDoc member, Tag[] firstSentenceTags, List<Content> tableContents, int counter) Deprecated.Add the member summary for the given class and member.void
addMemberTree
(Content memberSummaryTree, Content memberTree) Deprecated.Add the member tree to the member summary tree.void
close()
Deprecated.Close the writer.getInheritedSummaryHeader
(ClassDoc classDoc) Deprecated.Get the inherited member summary header for the given class.Deprecated.Get inherited summary links.getMemberSummaryHeader
(ClassDoc classDoc, Content memberSummaryTree) Deprecated.Get the member summary header for the given class.getMemberTree
(Content memberTree) Deprecated.Get the member tree.getSummaryTableTree
(ClassDoc classDoc, List<Content> tableContents) Deprecated.Get the summary table for the given class.
-
Method Details
-
getMemberSummaryHeader
Deprecated.Get the member summary header for the given class.- Parameters:
classDoc
- the class the summary belongs tomemberSummaryTree
- the content tree to which the member summary will be added- Returns:
- a content tree for the member summary header
-
getSummaryTableTree
Deprecated.Get the summary table for the given class.- Parameters:
classDoc
- the class the summary table belongs totableContents
- list of contents that will be added to the summary table- Returns:
- a content tree for the member summary table
-
addMemberSummary
void addMemberSummary(ClassDoc classDoc, ProgramElementDoc member, Tag[] firstSentenceTags, List<Content> tableContents, int counter) Deprecated.Add the member summary for the given class and member.- Parameters:
classDoc
- the class the summary belongs tomember
- the member that is documentedfirstSentenceTags
- the tags for the sentence being documentedtableContents
- list of contents to which the summary will be addedcounter
- the counter for determining id and style for the table row
-
getInheritedSummaryHeader
Deprecated.Get the inherited member summary header for the given class.- Parameters:
classDoc
- the class the summary belongs to- Returns:
- a content tree containing the inherited summary header
-
addInheritedMemberSummary
void addInheritedMemberSummary(ClassDoc classDoc, ProgramElementDoc member, boolean isFirst, boolean isLast, Content linksTree) Deprecated.Add the inherited member summary for the given class and member.- Parameters:
classDoc
- the class the inherited member belongs tomember
- the inherited member that is being documentedisFirst
- true if this is the first member in the listisLast
- true if this is the last member in the listlinksTree
- the content tree to which the links will be added
-
getInheritedSummaryLinksTree
Content getInheritedSummaryLinksTree()Deprecated.Get inherited summary links.- Returns:
- a content tree containing the inherited summary links
-
addMemberTree
Deprecated.Add the member tree to the member summary tree.- Parameters:
memberSummaryTree
- the content tree representing the member summarymemberTree
- the content tree representing the member
-
getMemberTree
Deprecated.Get the member tree.- Parameters:
memberTree
- the content tree representing the member- Returns:
- a content tree for the member
-
close
Deprecated.Close the writer.- Throws:
IOException
-