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

Schnittstelle FieldWriter

Alle Superschnittstellen:
MemberWriter
Alle bekannten Implementierungsklassen:
FieldWriterImpl, HtmlSerialFieldWriter
public interface FieldWriter extends MemberWriter
The interface for writing field output.

  • Methodendetails

    • getFieldDetailsHeader

      Content getFieldDetailsHeader(Content content)
      Get the field details header.
      Parameter:
      content - the content representing member details
      Gibt zurück:
      the field details header

    • getFieldHeaderContent

      Content getFieldHeaderContent(VariableElement field)
      Get the field documentation header.
      Parameter:
      field - the constructor being documented
      Gibt zurück:
      the field documentation header

    • getSignature

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

    • addDeprecated

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

    • addPreview

      void addPreview(VariableElement member, Content content)
      Adds 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 field, Content fieldContent)
      Add the comments for the given field.
      Parameter:
      field - the field being documented
      fieldContent - the content to which the comments will be added

    • addTags

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

    • getFieldDetails

      Content getFieldDetails(Content memberDetailsHeaderContent, Content memberContent)
      Get the field details.
      Parameter:
      memberDetailsHeaderContent - the content representing member details header
      memberContent - the content representing member details
      Gibt zurück:
      the field details

    • getMemberHeader

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