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.
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
-
Nested Class Summary
Nested classes/interfaces inherited from class gw.gosudoc.com.sun.tools.doclets.internal.toolkit.builders.AbstractBuilder
AbstractBuilder.Context
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final ClassDoc
Deprecated.The class whose constructors are being documented.private final List<ProgramElementDoc>
Deprecated.The constructors being documented.private int
Deprecated.The index of the current field that is being documented at this point in time.static final String
Deprecated.The name of this builder.private final VisibleMemberMap
Deprecated.The visible constructors for the given class.private final ConstructorWriter
Deprecated.The writer to output the constructor documentation.Fields inherited from class gw.gosudoc.com.sun.tools.doclets.internal.toolkit.builders.AbstractBuilder
configuration, containingPackagesSeen, DEBUG, layoutParser, utils
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprivate
ConstructorBuilder
(AbstractBuilder.Context context, ClassDoc classDoc, ConstructorWriter writer) Deprecated.Construct a new ConstructorBuilder. -
Method Summary
Modifier and TypeMethodDescriptionvoid
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.getName()
Deprecated.Return the name of this builder.Deprecated.Return the constructor writer for this builder.boolean
Deprecated.Return true if this subbuilder has anything to document.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 Details
-
NAME
Deprecated.The name of this builder.- See Also:
-
currentConstructorIndex
private int currentConstructorIndexDeprecated.The index of the current field that is being documented at this point in time. -
classDoc
Deprecated.The class whose constructors are being documented. -
visibleMemberMap
Deprecated.The visible constructors for the given class. -
writer
Deprecated.The writer to output the constructor documentation. -
constructors
Deprecated.The constructors being documented.
-
-
Constructor Details
-
ConstructorBuilder
private ConstructorBuilder(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.
-
-
Method Details
-
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
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
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
Deprecated.Return the constructor writer for this builder.- Returns:
- the constructor writer for this builder.
-
buildConstructorDoc
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
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
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
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
-
buildTagInfo
Deprecated.Build the tag information.- Parameters:
node
- the XML element that specifies which components to documentconstructorDocTree
- the content tree to which the documentation will be added
-