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

Klasse FieldBuilder

java.lang.Object
org.jdrupes.mdoclet.internal.doclets.toolkit.builders.AbstractBuilder
org.jdrupes.mdoclet.internal.doclets.toolkit.builders.AbstractMemberBuilder
org.jdrupes.mdoclet.internal.doclets.toolkit.builders.FieldBuilder
public class FieldBuilder extends AbstractMemberBuilder
Builds documentation for a field.

  • Methodendetails

    • getInstance

      public static FieldBuilder getInstance(AbstractBuilder.Context context, TypeElement typeElement, FieldWriter writer)
      Construct a new FieldBuilder.
      Parameter:
      context - the build context.
      typeElement - the class whose members are being documented.
      writer - the doclet specific writer.
      Gibt zurück:
      the new FieldBuilder

    • hasMembersToDocument

      public boolean hasMembersToDocument()
      Returns whether or not there are members to document.
      Angegeben von:
      hasMembersToDocument in Klasse AbstractMemberBuilder
      Gibt zurück:
      whether or not there are members to document

    • build

      public void build(Content target) throws DocletException
      Beschreibung aus Klasse kopiert: AbstractMemberBuilder
      Build the documentation.
      Angegeben von:
      build in Klasse AbstractMemberBuilder
      Parameter:
      target - the content into which to add the documentation
      Löst aus:
      DocletException - if there is a problem building the documentation

    • buildFieldDoc

      protected void buildFieldDoc(Content target) throws DocletException
      Build the field documentation.
      Parameter:
      target - the content to which the documentation will be added
      Löst aus:
      DocletException - if there is a problem while building the documentation

    • buildSignature

      protected void buildSignature(Content fieldContent)
      Build the signature.
      Parameter:
      fieldContent - the content to which the documentation will be added

    • buildDeprecationInfo

      protected void buildDeprecationInfo(Content fieldContent)
      Build the deprecation information.
      Parameter:
      fieldContent - the content to which the documentation will be added

    • buildPreviewInfo

      protected void buildPreviewInfo(Content fieldContent)
      Build the preview information.
      Parameter:
      fieldContent - the content to which the documentation will be added

    • buildFieldComments

      protected void buildFieldComments(Content fieldContent)
      Build the comments for the field.

      Do nothing if BaseOptions.noComment() is set to true.

      Parameter:
      fieldContent - the content to which the documentation will be added

    • buildTagInfo

      protected void buildTagInfo(Content fieldContent)
      Build the tag information.
      Parameter:
      fieldContent - the content to which the documentation will be added

    • getWriter

      public FieldWriter getWriter()
      Return the field writer for this builder.
      Gibt zurück:
      the field writer for this builder.