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

Schnittstelle ClassWriter

Alle bekannten Implementierungsklassen:
ClassWriterImpl
public interface ClassWriter
The interface for writing class output.

  • Methodendetails

    • getHeader

      Content getHeader(String header)
      Get the header of the page.
      Parameter:
      header - the header string to write
      Gibt zurück:
      header content that needs to be added to the documentation

    • getClassContentHeader

      Content getClassContentHeader()
      Get the class content header.
      Gibt zurück:
      class content header that needs to be added to the documentation

    • addClassTree

      void addClassTree(Content target)
      Add the class inheritance tree documentation.
      Parameter:
      target - the content to which the documentation will be added

    • addParamInfo

      void addParamInfo(Content target)
      Add the type parameter and state component information.
      Parameter:
      target - the content to which the documentation will be added

    • addSuperInterfacesInfo

      void addSuperInterfacesInfo(Content target)
      Add all superinterfaces if this is an interface.
      Parameter:
      target - the content to which the documentation will be added

    • addImplementedInterfacesInfo

      void addImplementedInterfacesInfo(Content target)
      Add all implemented interfaces if this is a class.
      Parameter:
      target - the content to which the documentation will be added

    • addSubClassInfo

      void addSubClassInfo(Content target)
      Add all the classes that extend this one.
      Parameter:
      target - the content to which the documentation will be added

    • addSubInterfacesInfo

      void addSubInterfacesInfo(Content target)
      Add all the interfaces that extend this one.
      Parameter:
      target - the content to which the documentation will be added

    • addInterfaceUsageInfo

      void addInterfaceUsageInfo(Content target)
      If this is an interface, add all classes that implement this interface.
      Parameter:
      target - the content to which the documentation will be added

    • addFunctionalInterfaceInfo

      void addFunctionalInterfaceInfo(Content target)
      If this is an functional interface, display appropriate message.
      Parameter:
      target - the content to which the documentation will be added

    • addNestedClassInfo

      void addNestedClassInfo(Content target)
      If this is an inner class or interface, add the enclosing class or interface.
      Parameter:
      target - the content to which the documentation will be added

    • getClassInfo

      Content getClassInfo(Content classInfo)
      Gibt the class information zurück.
      Parameter:
      classInfo - the class information
      Gibt zurück:
      the class information

    • addClassDeprecationInfo

      void addClassDeprecationInfo(Content classInfo)
      If this class is deprecated, add the appropriate information.
      Parameter:
      classInfo - the content to which the documentation will be added

    • addClassSignature

      void addClassSignature(Content classInfo)
      Add the signature of the current class content.
      Parameter:
      classInfo - the class content to which the signature will be added

    • addClassDescription

      void addClassDescription(Content classInfo)
      Build the class description.
      Parameter:
      classInfo - the content to which the documentation will be added

    • addClassTagInfo

      void addClassTagInfo(Content classInfo)
      Add the tag information for the current class.
      Parameter:
      classInfo - the content to which the tag information will be added

    • getSummariesList

      Content getSummariesList()
      Returns a list to be used for the list of summaries for members of a given kind.
      Gibt zurück:
      a list to be used for the list of summaries for members of a given kind

    • getSummariesListItem

      Content getSummariesListItem(Content content)
      Returns an item for the list of summaries for members of a given kind.
      Parameter:
      content - content for the item
      Gibt zurück:
      an item for the list of summaries for members of a given kind

    • getDetailsList

      Content getDetailsList()
      Returns a list to be used for the list of details for members of a given kind.
      Gibt zurück:
      a list to be used for the list of details for members of a given kind

    • getDetailsListItem

      Content getDetailsListItem(Content content)
      Returns an item for the list of details for members of a given kind.
      Parameter:
      content - content for the item
      Gibt zurück:
      an item for the list of details for members of a given kind

    • addClassContent

      void addClassContent(Content classContent)
      Add the class content.
      Parameter:
      classContent - the class content which will be added to the content

    • addFooter

      void addFooter()
      Add the footer of the page.

    • printDocument

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

    • getTypeElement

      TypeElement getTypeElement()
      Return the TypeElement being documented.
      Gibt zurück:
      the TypeElement being documented.

    • getMemberSummary

      Content getMemberSummary(Content memberContent)
      Gibt the member summary zurück.
      Parameter:
      memberContent - the content used to build the summary
      Gibt zurück:
      the member summary

    • getMemberDetails

      Content getMemberDetails(Content memberContent)
      Gibt the member details zurück.
      Parameter:
      memberContent - the content used to generate the member details
      Gibt zurück:
      the member details