Class ConstructorBuilder
- 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.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)
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class gw.gosudoc.com.sun.tools.doclets.internal.toolkit.builders.AbstractBuilder
AbstractBuilder.Context
-
-
Field Summary
Fields Modifier and Type Field Description static String
NAME
Deprecated.The name of this builder.-
Fields inherited from class gw.gosudoc.com.sun.tools.doclets.internal.toolkit.builders.AbstractBuilder
configuration, containingPackagesSeen, DEBUG, layoutParser, utils
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description void
buildConstructorComments(XMLNode node, Content constructorDocTree)
Deprecated.Build the comments for the constructor.void
buildConstructorDoc(XMLNode node, Content memberDetailsTree)
Deprecated.Build the constructor documentation.void
buildDeprecationInfo(XMLNode node, Content constructorDocTree)
Deprecated.Build the deprecation information.void
buildSignature(XMLNode node, Content constructorDocTree)
Deprecated.Build the signature.void
buildTagInfo(XMLNode node, Content constructorDocTree)
Deprecated.Build the tag information.static ConstructorBuilder
getInstance(AbstractBuilder.Context context, ClassDoc classDoc, ConstructorWriter writer)
Deprecated.Construct a new ConstructorBuilder.String
getName()
Deprecated.Return the name of this builder.ConstructorWriter
getWriter()
Deprecated.Return the constructor writer for this builder.boolean
hasMembersToDocument()
Deprecated.Return true if this subbuilder has anything to document.List<ProgramElementDoc>
members(ClassDoc classDoc)
Deprecated.Returns a list of constructors that will be documented for the given class.-
Methods inherited from class gw.gosudoc.com.sun.tools.doclets.internal.toolkit.builders.AbstractMemberBuilder
build, build
-
Methods inherited from class gw.gosudoc.com.sun.tools.doclets.internal.toolkit.builders.AbstractBuilder
buildChildren, invokeMethod
-
-
-
-
Field Detail
-
NAME
public static final String NAME
Deprecated.The name of this builder.- See Also:
- Constant Field Values
-
-
Method Detail
-
getInstance
public static ConstructorBuilder getInstance(AbstractBuilder.Context context, ClassDoc classDoc, ConstructorWriter writer)
Deprecated.Construct a new ConstructorBuilder.- 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 classAbstractBuilder
- Returns:
- the name of the builder.
-
hasMembersToDocument
public boolean hasMembersToDocument()
Deprecated.Return true if this subbuilder has anything to document.- Specified by:
hasMembersToDocument
in classAbstractMemberBuilder
- 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 documentmemberDetailsTree
- 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 documentconstructorDocTree
- 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 documentconstructorDocTree
- 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 ifConfiguration.nocomment
is set to true.- Parameters:
node
- the XML element that specifies which components to documentconstructorDocTree
- the content tree to which the documentation will be added
-
-