Interface MemberSummaryWriter

All Known Implementing Classes:
AnnotationTypeFieldWriterImpl, AnnotationTypeOptionalMemberWriterImpl, AnnotationTypeRequiredMemberWriterImpl, ConstructorWriterImpl, EnumConstantWriterImpl, FieldWriterImpl, HtmlSerialFieldWriter, HtmlSerialMethodWriter, MethodWriterImpl, NestedClassWriterImpl, PropertyWriterImpl

@Deprecated public interface MemberSummaryWriter
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 Details

    • getMemberSummaryHeader

      Content getMemberSummaryHeader(ClassDoc classDoc, Content memberSummaryTree)
      Deprecated.
      Get the member summary header for the given class.
      Parameters:
      classDoc - the class the summary belongs to
      memberSummaryTree - the content tree to which the member summary will be added
      Returns:
      a content tree for the member summary header
    • getSummaryTableTree

      Content getSummaryTableTree(ClassDoc classDoc, List<Content> tableContents)
      Deprecated.
      Get the summary table for the given class.
      Parameters:
      classDoc - the class the summary table belongs to
      tableContents - 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 to
      member - the member that is documented
      firstSentenceTags - the tags for the sentence being documented
      tableContents - list of contents to which the summary will be added
      counter - the counter for determining id and style for the table row
    • getInheritedSummaryHeader

      Content getInheritedSummaryHeader(ClassDoc classDoc)
      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 to
      member - the inherited member that is being documented
      isFirst - true if this is the first member in the list
      isLast - true if this is the last member in the list
      linksTree - 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

      void addMemberTree(Content memberSummaryTree, Content memberTree)
      Deprecated.
      Add the member tree to the member summary tree.
      Parameters:
      memberSummaryTree - the content tree representing the member summary
      memberTree - the content tree representing the member
    • getMemberTree

      Content getMemberTree(Content memberTree)
      Deprecated.
      Get the member tree.
      Parameters:
      memberTree - the content tree representing the member
      Returns:
      a content tree for the member
    • close

      void close() throws IOException
      Deprecated.
      Close the writer.
      Throws:
      IOException