Class MethodBuilder
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.MethodBuilder
Deprecated.
Builds documentation for a method.
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 methods are being documented.private int
Deprecated.The index of the current field that is being documented at this point in time.private List<ProgramElementDoc>
Deprecated.The methods being documented.private final VisibleMemberMap
Deprecated.The visible methods for the given class.private final MethodWriter
Deprecated.The writer to output the method documentation.Fields inherited from class gw.gosudoc.com.sun.tools.doclets.internal.toolkit.builders.AbstractBuilder
configuration, containingPackagesSeen, DEBUG, layoutParser, utils
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprivate
MethodBuilder
(AbstractBuilder.Context context, ClassDoc classDoc, MethodWriter writer) Deprecated.Construct a new MethodBuilder. -
Method Summary
Modifier and TypeMethodDescriptionvoid
buildDeprecationInfo
(XMLNode node, Content methodDocTree) Deprecated.Build the deprecation information.void
buildMethodComments
(XMLNode node, Content methodDocTree) Deprecated.Build the comments for the method.void
buildMethodDoc
(XMLNode node, Content memberDetailsTree) Deprecated.Build the method documentation.void
buildSignature
(XMLNode node, Content methodDocTree) Deprecated.Build the signature.void
buildTagInfo
(XMLNode node, Content methodDocTree) Deprecated.Build the tag information.static MethodBuilder
getInstance
(AbstractBuilder.Context context, ClassDoc classDoc, MethodWriter writer) Deprecated.Construct a new MethodBuilder.getName()
Deprecated.Return the name of this builder.Deprecated.Returns the visible member map for the methods of this class.Deprecated.Return the method writer for this builder.boolean
Deprecated.Return true if this subbuilder has anything to document.Deprecated.Returns a list of methods 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
-
currentMethodIndex
private int currentMethodIndexDeprecated.The index of the current field that is being documented at this point in time. -
classDoc
Deprecated.The class whose methods are being documented. -
visibleMemberMap
Deprecated.The visible methods for the given class. -
writer
Deprecated.The writer to output the method documentation. -
methods
Deprecated.The methods being documented.
-
-
Constructor Details
-
MethodBuilder
Deprecated.Construct a new MethodBuilder.- Parameters:
context
- the build context.classDoc
- the class whoses members are being documented.writer
- the doclet specific writer.
-
-
Method Details
-
getInstance
public static MethodBuilder getInstance(AbstractBuilder.Context context, ClassDoc classDoc, MethodWriter writer) Deprecated.Construct a new MethodBuilder.- Parameters:
context
- the build context.classDoc
- the class whoses members are being documented.writer
- the doclet specific writer.- Returns:
- an instance of a MethodBuilder.
-
getName
Deprecated.Return the name of this builder.- Specified by:
getName
in classAbstractBuilder
- Returns:
- the name of the builder.
-
members
Deprecated.Returns a list of methods that will be documented for the given class. This information can be used for doclet specific documentation generation.- Parameters:
classDoc
- theClassDoc
we want to check.- Returns:
- a list of methods that will be documented.
-
getVisibleMemberMap
Deprecated.Returns the visible member map for the methods of this class.- Returns:
- the visible member map for the methods of this class.
-
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.
-
buildMethodDoc
Deprecated.Build the method 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 documentmethodDocTree
- 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 documentmethodDocTree
- the content tree to which the documentation will be added
-
buildMethodComments
Deprecated.Build the comments for the method. Do nothing ifConfiguration.nocomment
is set to true.- Parameters:
node
- the XML element that specifies which components to documentmethodDocTree
- 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 documentmethodDocTree
- the content tree to which the documentation will be added
-
getWriter
Deprecated.Return the method writer for this builder.- Returns:
- the method writer for this builder.
-