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

Schnittstelle EnumConstantWriter

Alle Superschnittstellen:
MemberWriter
Alle bekannten Implementierungsklassen:
EnumConstantWriterImpl
public interface EnumConstantWriter extends MemberWriter
The interface for writing enum constant output.

  • Methodendetails

    • getEnumConstantsDetailsHeader

      Content getEnumConstantsDetailsHeader(TypeElement typeElement, Content memberDetails)
      Get the enum constants details header.
      Parameter:
      typeElement - the class being documented
      memberDetails - the content representing member details
      Gibt zurück:
      a content for the enum constants details header

    • getEnumConstantsHeader

      Content getEnumConstantsHeader(VariableElement enumConstant, Content enumConstantsDetails)
      Get the enum constants documentation header.
      Parameter:
      enumConstant - the enum constant being documented
      enumConstantsDetails - the content representing enum constant details
      Gibt zurück:
      the enum constant documentation header

    • getSignature

      Content getSignature(VariableElement enumConstant)
      Get the signature for the given enum constant.
      Parameter:
      enumConstant - the enum constant being documented
      Gibt zurück:
      the enum constant signature

    • addDeprecated

      void addDeprecated(VariableElement enumConstant, Content content)
      Add the deprecated output for the given enum constant.
      Parameter:
      enumConstant - the enum constant being documented
      content - the content to which the deprecated information will be added

    • addPreview

      void addPreview(VariableElement member, Content content)
      Add the preview output for the given member.
      Parameter:
      member - the member being documented
      content - the content to which the preview information will be added

    • addComments

      void addComments(VariableElement enumConstant, Content enumConstants)
      Add the comments for the given enum constant.
      Parameter:
      enumConstant - the enum constant being documented
      enumConstants - the content to which the comments will be added

    • addTags

      void addTags(VariableElement enumConstant, Content content)
      Add the tags for the given enum constant.
      Parameter:
      enumConstant - the enum constant being documented
      content - the content to which the tags will be added

    • getEnumConstantsDetails

      Content getEnumConstantsDetails(Content memberDetailsHeader, Content content)
      Get the enum constants details.
      Parameter:
      memberDetailsHeader - member details header
      content - the content representing member details
      Gibt zurück:
      the enum constant details

    • getMemberHeader

      Content getMemberHeader()
      Gets the member header.
      Gibt zurück:
      the member header