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

Schnittstelle SerializedFormWriter.SerialFieldWriter

Alle bekannten Implementierungsklassen:
HtmlSerialFieldWriter
Umschließende Schnittstelle:
SerializedFormWriter
public static interface SerializedFormWriter.SerialFieldWriter
A writer for the serialized form for a given field.

  • Methodendetails

    • getSerializableFieldsHeader

      Content getSerializableFieldsHeader()
      Gibt the serializable field header zurück.
      Gibt zurück:
      the serializable field header

    • getFieldsContentHeader

      Content getFieldsContentHeader(boolean isLastContent)
      Gibt the field content header zurück.
      Parameter:
      isLastContent - true if this is the last content to be documented
      Gibt zurück:
      the field content header

    • getSerializableFields

      Content getSerializableFields(String heading, Content content)
      Gibt the fields zurück.
      Parameter:
      heading - the heading to write.
      content - the content to be added
      Gibt zurück:
      serializable fields content

    • addMemberDeprecatedInfo

      void addMemberDeprecatedInfo(VariableElement field, Content content)
      Adds the deprecated information for this member.
      Parameter:
      field - the field to document.
      content - the content to which the deprecated information will be added

    • addMemberDescription

      void addMemberDescription(VariableElement field, Content content)
      Adds the description text for this member.
      Parameter:
      field - the field to document
      content - the content to which the member description will be added

    • addMemberDescription

      void addMemberDescription(VariableElement field, SerialFieldTree serialFieldTag, Content content)
      Adds the description text for this member represented by the tag.
      Parameter:
      field - the field to document
      serialFieldTag - the field to document (represented by tag)
      content - the content to which the member description will be added

    • addMemberTags

      void addMemberTags(VariableElement field, Content content)
      Adds the tag information for this member.
      Parameter:
      field - the field to document
      content - the content to which the member tags will be added

    • addMemberHeader

      void addMemberHeader(TypeMirror fieldType, String fieldName, Content content)
      Adds the member header.
      Parameter:
      fieldType - the type of the field
      fieldName - the name of the field
      content - the content to which the member header will be added

    • shouldPrintOverview

      boolean shouldPrintOverview(VariableElement field)
      Check to see if overview details should be printed.

      If nocomment option set or if there is no text to be printed for deprecation info, inline comment or tags, do not print overview details.

      Parameter:
      field - the field to check overview details for
      Gibt zurück:
      true if overview details need to be printed