Package gw.gosudoc.com.sun.tools.doclets.internal.toolkit.builders

Class FieldBuilder

java.lang.Object
gw.gosudoc.com.sun.tools.doclets.internal.toolkit.builders.AbstractBuilder
gw.gosudoc.com.sun.tools.doclets.internal.toolkit.builders.AbstractMemberBuilder
gw.gosudoc.com.sun.tools.doclets.internal.toolkit.builders.FieldBuilder
@Deprecated public class FieldBuilder extends AbstractMemberBuilder
Deprecated.
Builds documentation for a field.

This is NOT part of any supported API. If you write code that depends on this, you do so at your own risk. This code and its internal interfaces are subject to change or deletion without notice.

Since:
1.5
Author:
Jamie Ho, Bhavesh Patel (Modified)

  • Method Details

    • getInstance

      public static FieldBuilder getInstance(AbstractBuilder.Context context, ClassDoc classDoc, FieldWriter writer)
      Deprecated.
      Construct a new FieldBuilder.
      Parameters:
      context - the build context.
      classDoc - the class whoses members are being documented.
      writer - the doclet specific writer.

    • getName

      public String getName()
      Deprecated.
      Return the name of this builder.
      Specified by:
      getName in class AbstractBuilder
      Returns:
      the name of the builder.

    • members

      public List<ProgramElementDoc> members(ClassDoc classDoc)
      Deprecated.
      Returns a list of fields that will be documented for the given class. This information can be used for doclet specific documentation generation.
      Parameters:
      classDoc - the ClassDoc we want to check.
      Returns:
      a list of fields that will be documented.

    • getVisibleMemberMap

      public VisibleMemberMap getVisibleMemberMap()
      Deprecated.
      Returns the visible member map for the fields of this class.
      Returns:
      the visible member map for the fields of this class.

    • hasMembersToDocument

      public boolean hasMembersToDocument()
      Deprecated.
      summaryOrder.size()
      Specified by:
      hasMembersToDocument in class AbstractMemberBuilder
      Returns:
      true if this subbuilder has anything to document.

    • buildFieldDoc

      public void buildFieldDoc(XMLNode node, Content memberDetailsTree)
      Deprecated.
      Build the field documentation.
      Parameters:
      node - the XML element that specifies which components to document
      memberDetailsTree - the content tree to which the documentation will be added

    • buildSignature

      public void buildSignature(XMLNode node, Content fieldDocTree)
      Deprecated.
      Build the signature.
      Parameters:
      node - the XML element that specifies which components to document
      fieldDocTree - the content tree to which the documentation will be added

    • buildDeprecationInfo

      public void buildDeprecationInfo(XMLNode node, Content fieldDocTree)
      Deprecated.
      Build the deprecation information.
      Parameters:
      node - the XML element that specifies which components to document
      fieldDocTree - the content tree to which the documentation will be added

    • buildFieldComments

      public void buildFieldComments(XMLNode node, Content fieldDocTree)
      Deprecated.
      Build the comments for the field. Do nothing if Configuration.nocomment is set to true.
      Parameters:
      node - the XML element that specifies which components to document
      fieldDocTree - the content tree to which the documentation will be added

    • buildTagInfo

      public void buildTagInfo(XMLNode node, Content fieldDocTree)
      Deprecated.
      Build the tag information.
      Parameters:
      node - the XML element that specifies which components to document
      fieldDocTree - the content tree to which the documentation will be added

    • getWriter

      public FieldWriter getWriter()
      Deprecated.
      Return the field writer for this builder.
      Returns:
      the field writer for this builder.