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

Schnittstelle ModuleSummaryWriter

Alle bekannten Implementierungsklassen:
ModuleWriterImpl
public interface ModuleSummaryWriter
The interface for writing module summary output.

  • Methodendetails

    • getModuleHeader

      Content getModuleHeader(String heading)
      Get the header for the summary.
      Parameter:
      heading - module name.
      Gibt zurück:
      the header to be added to the content

    • getContentHeader

      Content getContentHeader()
      Get the header for the module content.
      Gibt zurück:
      the module content header

    • getSummariesList

      Content getSummariesList()
      Get the header for the summary header.
      Gibt zurück:
      the summary header

    • getSummary

      Content getSummary(Content source)
      Wrap the content into summary section.
      Parameter:
      source - the content to wrap into the summary section
      Gibt zurück:
      the summary

    • addModuleDescription

      void addModuleDescription(Content moduleContent)
      Adds the module description.
      Parameter:
      moduleContent - the content to which the module description will be added

    • addModuleSignature

      void addModuleSignature(Content moduleContent)
      Adds the module signature.
      Parameter:
      moduleContent - the content to which the module signature will be added

    • addModulesSummary

      void addModulesSummary(Content summariesList)
      Adds the summary of modules to the list of summaries.
      Parameter:
      summariesList - the list of summaries

    • addPackagesSummary

      void addPackagesSummary(Content summariesList)
      Adds the summary of packages to the list of summaries.
      Parameter:
      summariesList - the list of summaries

    • addServicesSummary

      void addServicesSummary(Content summariesList)
      Adds the summary of services to the list of summaries.
      Parameter:
      summariesList - the list of summaries

    • addModuleContent

      void addModuleContent(Content source)
      Adds the module content to the documentation.
      Parameter:
      source - the content that will be added

    • addModuleFooter

      void addModuleFooter()
      Adds the footer to the documentation.

    • printDocument

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