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

Schnittstelle ConstantsSummaryWriter

Alle bekannten Implementierungsklassen:
ConstantsSummaryWriterImpl
public interface ConstantsSummaryWriter
The interface for writing constants summary output.

  • Methodendetails

    • getHeader

      Content getHeader()
      Get the header for the constant summary documentation.
      Gibt zurück:
      header that needs to be added to the documentation

    • getContentsHeader

      Content getContentsHeader()
      Get the header for the constant content list.
      Gibt zurück:
      content header that needs to be added to the documentation

    • addLinkToPackageContent

      void addLinkToPackageContent(String abbrevPackageName, Content content)
      Adds the given package name link to the constant content list.
      Parameter:
      abbrevPackageName - the abbreviated package name
      content - the content to which the link will be added

    • addContentsList

      void addContentsList(Content content)
      Add the content list to the documentation.
      Parameter:
      content - the content that will be added to the list

    • getConstantSummaries

      Content getConstantSummaries()
      Get the constant summaries for the document.
      Gibt zurück:
      constant summaries header to be added to the documentation

    • addPackageGroup

      void addPackageGroup(String abbrevPackageName, Content toContent)
      Adds a header for the given abbreviated package name.
      Parameter:
      abbrevPackageName - the abbreviated package name
      toContent - the summaries documentation

    • getClassConstantHeader

      Content getClassConstantHeader()
      Get the class summary header for the constants summary.
      Gibt zurück:
      the header content for the class constants summary

    • addClassConstant

      void addClassConstant(Content fromClassConstant)
      Add the content list to the documentation summaries.
      Parameter:
      fromClassConstant - the class constant content that will be added to the list

    • addConstantMembers

      void addConstantMembers(TypeElement typeElement, Collection<VariableElement> fields, Content target)
      Adds the constant member table to the documentation.
      Parameter:
      typeElement - the class whose constants are being documented.
      fields - the constants being documented.
      target - the content to which the constant member table content will be added

    • addConstantSummaries

      void addConstantSummaries(Content content)
      Add the summaries list to the content.
      Parameter:
      content - the summaries content that will be added to the list

    • addFooter

      void addFooter()
      Adds the footer for the summary documentation.

    • printDocument

      void printDocument(Content content) throws DocFileIOException
      Print the constants summary document.
      Parameter:
      content - the content which should be printed
      Löst aus:
      DocFileIOException - if there is a problem while writing the document