Package org.jdrupes.mdoclet.internal.doclets.toolkit

Schnittstelle MemberSummaryWriter

Alle bekannten Implementierungsklassen:
AbstractExecutableMemberWriter, AbstractMemberWriter, AnnotationTypeMemberWriterImpl, ConstructorWriterImpl, EnumConstantWriterImpl, FieldWriterImpl, HtmlSerialFieldWriter, HtmlSerialMethodWriter, MethodWriterImpl, NestedClassWriterImpl, PropertyWriterImpl
public interface MemberSummaryWriter
The interface for writing member summary output.

  • Methodendetails

    • getMemberSummaryHeader

      Content getMemberSummaryHeader(TypeElement typeElement, Content content)
      Returns the member summary header for the given class.
      Parameter:
      typeElement - the class the summary belongs to
      content - the content to which the member summary will be added
      Gibt zurück:
      the member summary header

    • getSummaryTable

      Content getSummaryTable(TypeElement typeElement)
      Returns the summary table for the given class.
      Parameter:
      typeElement - the class the summary table belongs to
      Gibt zurück:
      the summary table

    • addMemberSummary

      void addMemberSummary(TypeElement typeElement, Element member, List<? extends DocTree> firstSentenceTrees)
      Adds the member summary for the given class and member.
      Parameter:
      typeElement - the class the summary belongs to
      member - the member that is documented
      firstSentenceTrees - the tags for the sentence being documented

    • getInheritedSummaryHeader

      Content getInheritedSummaryHeader(TypeElement typeElement)
      Returns the inherited member summary header for the given class.
      Parameter:
      typeElement - the class the summary belongs to
      Gibt zurück:
      the inherited member summary header

    • addInheritedMemberSummary

      void addInheritedMemberSummary(TypeElement typeElement, Element member, boolean isFirst, boolean isLast, Content content)
      Adds the inherited member summary for the given class and member.
      Parameter:
      typeElement - 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
      content - the content to which the links will be added

    • getInheritedSummaryLinks

      Content getInheritedSummaryLinks()
      Returns the inherited summary links.
      Gibt zurück:
      the inherited summary links

    • addSummary

      void addSummary(Content summariesList, Content content)
      Adds the given summary to the list of summaries.
      Parameter:
      summariesList - the list of summaries
      content - the summary

    • getMember

      Content getMember(Content memberContent)
      Returns the member content.
      Parameter:
      memberContent - the content representing the member
      Gibt zurück:
      the member content