Class ConstructorBuilder


  • @Deprecated
    public class ConstructorBuilder
    extends AbstractMemberBuilder
    Deprecated.
    Builds documentation for a constructor.

    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 Detail

      • getName

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

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

        public List<ProgramElementDoc> members​(ClassDoc classDoc)
        Deprecated.
        Returns a list of constructors that will be documented for the given class. This information can be used for doclet specific documentation generation.
        Returns:
        a list of constructors that will be documented.
      • getWriter

        public ConstructorWriter getWriter()
        Deprecated.
        Return the constructor writer for this builder.
        Returns:
        the constructor writer for this builder.
      • buildConstructorDoc

        public void buildConstructorDoc​(XMLNode node,
                                        Content memberDetailsTree)
        Deprecated.
        Build the constructor 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 constructorDocTree)
        Deprecated.
        Build the signature.
        Parameters:
        node - the XML element that specifies which components to document
        constructorDocTree - the content tree to which the documentation will be added
      • buildDeprecationInfo

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

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

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